Interface IApiKeyOptions

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

The options for creating an API Key.

public interface IApiKeyOptions : IResourceOptions

Inherited Members

IResourceOptions.DefaultCorsPreflightOptions

IResourceOptions.DefaultIntegration

IResourceOptions.DefaultMethodOptions

Examples

RestApi api;

            var key = api.AddApiKey("ApiKey", new ApiKeyOptions {
                ApiKeyName = "myApiKey1",
                Value = "MyApiKeyThatIsAtLeast20Characters"
            });

Remarks

ExampleMetadata: infused

Properties

ApiKeyName

A name for the API key.

string? ApiKeyName { get; }

Property Value

string

Remarks

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name.

Default: automically generated name

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-name

Description

A description of the purpose of the API key.

string? Description { get; }

Property Value

string

Remarks

Default: none

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-description

Value

The value of the API key.

string? Value { get; }

Property Value

string

Remarks

Must be at least 20 characters long.

Default: none

Link: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-value