Class CfnApiKeyProps

Properties for defining a CfnApiKey.

Inheritance

System.Object

CfnApiKeyProps

Implements

ICfnApiKeyProps

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnApiKeyProps : Object, ICfnApiKeyProps

Syntax (vb)

Public Class CfnApiKeyProps
    Inherits Object
    Implements ICfnApiKeyProps

Remarks

Link: 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;

CfnApiKeyProps 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

Constructors

CfnApiKeyProps()

Properties

CustomerId	An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
Description	A description of the purpose of the API key.
Enabled	Indicates whether the API key can be used by clients.
GenerateDistinctId	Specifies whether the key identifier is distinct from the created API key value.
Name	A name for the API key.
StageKeys	A list of stages to associate with this API key.
Tags	An array of arbitrary tags (key-value pairs) to associate with the API key.
Value	The value of the API key.

Constructors

CfnApiKeyProps()

public CfnApiKeyProps()

Properties

CustomerId

An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.

public string CustomerId { get; set; }

Property Value

System.String

Remarks

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

Description

A description of the purpose of the API key.

public string Description { get; set; }

Property Value

System.String

Remarks

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

Enabled

Indicates whether the API key can be used by clients.

public object Enabled { get; set; }

Property Value

System.Object

Remarks

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

GenerateDistinctId

Specifies whether the key identifier is distinct from the created API key value.

public object GenerateDistinctId { get; set; }

Property Value

System.Object

Remarks

This parameter is deprecated and should not be used.

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

Name

A name for the API key.

public string Name { get; set; }

Property Value

System.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.

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

StageKeys

A list of stages to associate with this API key.

public object StageKeys { get; set; }

Property Value

System.Object

Remarks

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

Tags

An array of arbitrary tags (key-value pairs) to associate with the API key.

public ICfnTag[] Tags { get; set; }

Property Value

ICfnTag[]

Remarks

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

Value

The value of the API key.

public string Value { get; set; }

Property Value

System.String

Remarks

Must be at least 20 characters long.

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

Implements

ICfnApiKeyProps