aws-cdk-lib.aws_apigateway.AddApiKeyOptions

interface AddApiKeyOptions

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.AddApiKeyOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#AddApiKeyOptions
Javasoftware.amazon.awscdk.services.apigateway.AddApiKeyOptions
Pythonaws_cdk.aws_apigateway.AddApiKeyOptions
TypeScript (source)aws-cdk-lib » 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

NameTypeDescription
overrideLogicalId?stringOverride 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.