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.104.0 (build e79254c)",
date="2024-12-06T14:43:13.259Z")
@Stability(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
Modifier and TypeInterfaceDescriptionstatic final class
A builder forApiKeyOptions
static final class
An implementation forApiKeyOptions
-
Method Summary
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
Methods inherited from interface software.amazon.awscdk.services.apigateway.ResourceOptions
getDefaultCorsPreflightOptions, getDefaultIntegration, getDefaultMethodOptions
-
Method Details
-
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
A description of the purpose of the API key.Default: none
-
getValue
The value of the API key.Must be at least 20 characters long.
Default: none
-
builder
- Returns:
- a
ApiKeyOptions.Builder
ofApiKeyOptions
-