aws-cdk-lib.aws_apigatewayv2.AddApiKeyOptions

AddApiKeyOptions Struct

Options to the UsagePlan.addApiKey() method.

Source

aws-apigatewayv2/lib/websocket/usage-plan.ts

Type last changed

v2.212.0 · 20 Aug 2025

Example

declare const usagePlan: apigwv2.UsagePlan;
declare const apiKey: apigwv2.ApiKey;

usagePlan.addApiKey(apiKey, {
 overrideLogicalId: 'MyCustomLogicalId',
});

Properties

overrideLogicalIdstringoverride_logical_idstroverrideLogicalIdStringOverrideLogicalIdstringOverrideLogicalId*string= autogenerated by the CDK#

Override the CloudFormation logical id of the AWS::ApiGateway::UsagePlanKey resource.