Interface IApiKeyOptions

The options for creating an API Key.

public interface IApiKeyOptions : IResourceOptions

Public Interface IApiKeyOptions
    Inherits IResourceOptions

ExampleMetadata: infused

RestApi api;

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

ApiKeyName	A name for the API key.
Description	A description of the purpose of the API key.
Value	The value of the API key.

A name for the API key.

virtual string ApiKeyName { get; }

System.String

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

A description of the purpose of the API key.

virtual string Description { get; }

System.String

Default: none

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

The value of the API key.

virtual string Value { get; }

System.String

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