Interface ICfnApiKeyProps

Properties for defining a CfnApiKey.

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnApiKeyProps

Syntax (vb)

Public Interface ICfnApiKeyProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html

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.APIGateway;

             var cfnApiKeyProps = new CfnApiKeyProps {
                 CustomerId = "customerId",
                 Description = "description",
                 Enabled = false,
                 GenerateDistinctId = false,
                 Name = "name",
                 StageKeys = new [] { new StageKeyProperty {
                     RestApiId = "restApiId",
                     StageName = "stageName"
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Value = "value"
             };

Synopsis

Properties

CustomerId	An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace.
Description	The description of the ApiKey.
Enabled	Specifies whether the ApiKey can be used by callers.
GenerateDistinctId	Specifies whether ( true ) or not ( false ) the key identifier is distinct from the created API key value.
Name	A name for the API key.
StageKeys	DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
Tags	The key-value map of strings.
Value	Specifies a value of the API key.

Properties

CustomerId

An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace.

string? CustomerId { get; }

Property Value

string

Remarks

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

Description

The description of the ApiKey.

string? Description { get; }

Property Value

string

Remarks

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

Enabled

Specifies whether the ApiKey can be used by callers.

object? Enabled { get; }

Property Value

object

Remarks

Default: - false

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

GenerateDistinctId

Specifies whether ( true ) or not ( false ) the key identifier is distinct from the created API key value.

object? GenerateDistinctId { get; }

Property Value

object

Remarks

This parameter is deprecated and should not be used.

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

Name

A name for the API key.

string? Name { 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. For more information, see Name Type .

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

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

StageKeys

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

object? StageKeys { get; }

Property Value

object

Remarks

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

Tags

The key-value map of strings.

ICfnTag[]? Tags { get; }

Property Value

ICfnTag[]

Remarks

The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws: . The tag value can be up to 256 characters.

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

Value

Specifies a value of the API key.

string? Value { get; }

Property Value

string

Remarks

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