aws-cdk-lib.aws_apigateway.AddApiKeyOptions

AddApiKeyOptions Struct

Options to the UsagePlan.addApiKey() method.

Source

aws-apigateway/lib/usage-plan.ts

Example

declare const usageplan: apigateway.UsagePlan;
declare const apiKey: apigateway.ApiKey;

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

Properties

overrideLogicalId?optionalstringoverride_logical_id?optionalstroverrideLogicalId?optionalStringOverrideLogicalId?optionalstringOverrideLogicalId?optional*string#

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

Default: autogenerated by the CDK