software.amazon.awscdk.services.apigateway

Interface AddApiKeyOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AddApiKeyOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.081Z")
 @Stability(value=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("...")
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and 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 Detail

getOverrideLogicalId

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

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

Default: - autogenerated by the CDK

builder

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

Returns:

a AddApiKeyOptions.Builder of AddApiKeyOptions