software.amazon.awscdk.services.apigateway

Interface ApiKeyOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, ResourceOptions

All Known Subinterfaces:

ApiKeyProps, RateLimitedApiKeyProps

All Known Implementing Classes:

ApiKeyOptions.Jsii$Proxy, ApiKeyProps.Jsii$Proxy, RateLimitedApiKeyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.084Z")
 @Stability(value=Stable)
public interface ApiKeyOptions
extends software.amazon.jsii.JsiiSerializable, ResourceOptions

The options for creating an API Key.

Example:

 RestApi api;
 IApiKey key = api.addApiKey("ApiKey", ApiKeyOptions.builder()
         .apiKeyName("myApiKey1")
         .value("MyApiKeyThatIsAtLeast20Characters")
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ApiKeyOptions.Builder	builder()
default String	getApiKeyName() A name for the API key.
default String	getDescription() A description of the purpose of the API key.
default String	getValue() The value of the API key.

Methods inherited from interface software.amazon.awscdk.services.apigateway.ResourceOptions

getDefaultCorsPreflightOptions, getDefaultIntegration, getDefaultMethodOptions

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApiKeyName

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

A name for the API key.

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name.

Default: automically generated name

getDescription

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

A description of the purpose of the API key.

Default: none

getValue

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

The value of the API key.

Must be at least 20 characters long.

Default: none

builder

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

Specified by:

builder in interface ResourceOptions

Returns:

a ApiKeyOptions.Builder of ApiKeyOptions