Class CfnApiKeyProps
Properties for defining a CfnApiKey
.
Inheritance
Implements
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;
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
Constructors
CfnApiKeyProps() |
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 ( |
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. |
Constructors
CfnApiKeyProps()
public CfnApiKeyProps()
Properties
CustomerId
An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace.
public string CustomerId { get; set; }
Property Value
System.String
Remarks
Description
The description of the ApiKey.
public string Description { get; set; }
Property Value
System.String
Remarks
Enabled
Specifies whether the ApiKey can be used by callers.
public object Enabled { get; set; }
Property Value
System.Object
Remarks
GenerateDistinctId
Specifies whether ( true
) or not ( false
) 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.
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.
StageKeys
DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
public object StageKeys { get; set; }
Property Value
System.Object
Remarks
Tags
The key-value map of strings.
public ICfnTag[] Tags { get; set; }
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.
Value
Specifies a value of the API key.
public string Value { get; set; }
Property Value
System.String