Interface IApiKeyOptions
The options for creating an API Key.
Inherited Members
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IApiKeyOptions : IResourceOptions
Syntax (vb)
Public Interface IApiKeyOptions
Inherits IResourceOptions
Remarks
ExampleMetadata: infused
Examples
RestApi api;
var key = api.AddApiKey("ApiKey", new ApiKeyOptions {
ApiKeyName = "myApiKey1",
Value = "MyApiKeyThatIsAtLeast20Characters"
});
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.
virtual string ApiKeyName { get; }
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.
Default: automically generated name
Description
A description of the purpose of the API key.
virtual string Description { get; }
Property Value
System.String
Remarks
Value
The value of the API key.
virtual string Value { get; }
Property Value
System.String
Remarks
Must be at least 20 characters long.
Default: none