Show / Hide Table of Contents

Interface IApiKeyOptions

The options for creating an API Key.

Namespace: Amazon.CDK.AWS.Apigatewayv2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IApiKeyOptions

Syntax (vb)

Public Interface IApiKeyOptions

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.Apigatewayv2;

            var apiKeyOptions = new ApiKeyOptions {
                ApiKeyName = "apiKeyName",
                Description = "description",
                Value = "value"
            };

Synopsis

Properties

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

Properties

ApiKeyName

A name for the API key.

string? ApiKeyName { get; }

Property Value

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: automatically 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

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

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