interface AddApiKeyOptions
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Apigatewayv2.AddApiKeyOptions |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#AddApiKeyOptions |
 Java | software.amazon.awscdk.services.apigatewayv2.AddApiKeyOptions |
 Python | aws_cdk.aws_apigatewayv2.AddApiKeyOptions |
 TypeScript (source) | aws-cdk-lib » aws_apigatewayv2 » AddApiKeyOptions |
Options to the UsagePlan.addApiKey() method.
Example
declare const usagePlan: apigwv2.UsagePlan;
declare const apiKey: apigwv2.ApiKey;
usagePlan.addApiKey(apiKey, {
overrideLogicalId: 'MyCustomLogicalId',
});
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.