Package software.amazon.awscdk.services.apigatewayv2

Interface AddApiKeyOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AddApiKeyOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-01-09T10:20:10.423Z")
@Stability(Stable)
public interface AddApiKeyOptions
extends software.amazon.jsii.JsiiSerializable

Options to the UsagePlan.addApiKey() method.

Example:

 UsagePlan usagePlan;
 ApiKey apiKey;
 usagePlan.addApiKey(apiKey, AddApiKeyOptions.builder()
         .overrideLogicalId("MyCustomLogicalId")
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AddApiKeyOptions.Builder	A builder for AddApiKeyOptions
static final class	AddApiKeyOptions.Jsii$Proxy	An implementation for AddApiKeyOptions

Method Summary

Modifier and Type	Method	Description
static AddApiKeyOptions.Builder	builder()
default String	getOverrideLogicalId()	Override the CloudFormation logical id of the AWS::ApiGateway::UsagePlanKey resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getOverrideLogicalId

@Stability(Stable)
@Nullable
default String getOverrideLogicalId()

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

Default: - autogenerated by the CDK

builder

@Stability(Stable)
static AddApiKeyOptions.Builder builder()

Returns:

a AddApiKeyOptions.Builder of AddApiKeyOptions