interface AddApiKeyOptions
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.APIGateway.AddApiKeyOptions |
 Java | software.amazon.awscdk.services.apigateway.AddApiKeyOptions |
 Python | aws_cdk.aws_apigateway.AddApiKeyOptions |
 TypeScript (source) | @aws-cdk/aws-apigateway » AddApiKeyOptions |
Options to the UsagePlan.addApiKey() method.
Example
declare const usageplan: apigateway.UsagePlan;
declare const apiKey: apigateway.ApiKey;
usageplan.addApiKey(apiKey, {
overrideLogicalId: '...',
});
Properties
| Name | Type | Description |
|---|---|---|
| override | string | Override the CloudFormation logical id of the AWS::ApiGateway::UsagePlanKey resource. |
overrideLogicalId?
Type:
string
(optional, default: autogenerated by the CDK)
Override the CloudFormation logical id of the AWS::ApiGateway::UsagePlanKey resource.