Skip to content
v2.278.0

AddApiKeyOptions Struct ​

Options to the UsagePlan.addApiKey() method.

Example ​

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

usageplan.addApiKey(apiKey, {
  overrideLogicalId: '...',
});
python
# usageplan: apigateway.UsagePlan
# api_key: apigateway.ApiKey


usageplan.add_api_key(api_key,
    override_logical_id="..."
)
java
UsagePlan usageplan;
ApiKey apiKey;


usageplan.addApiKey(apiKey, AddApiKeyOptions.builder()
        .overrideLogicalId("...")
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
UsagePlan usageplan;
ApiKey apiKey;


usageplan.AddApiKey(apiKey, new AddApiKeyOptions {
    OverrideLogicalId = "..."
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var usageplan UsagePlan
var apiKey ApiKey


usageplan.addApiKey(apiKey, &AddApiKeyOptions{
	OverrideLogicalId: jsii.String("..."),
})

Properties ​

overrideLogicalIdoptionalstringoverride_logical_idoptionalstroverrideLogicalIdoptionalStringOverrideLogicalIdoptionalstringOverrideLogicalIdoptional*string #
Override the CloudFormation logical id of the AWS::ApiGateway::UsagePlanKey resource.

Default: autogenerated by the CDK