software.amazon.awscdk.services.apigateway

Interface ApiKeyProps

All Superinterfaces:

ApiKeyOptions, ResourceOptions

All Known Subinterfaces:

RateLimitedApiKeyProps

All Known Implementing Classes:

ApiKeyProps.Jsii$Proxy, RateLimitedApiKeyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:08.244Z")
public interface ApiKeyProps
extends ApiKeyOptions

ApiKey Properties.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 import software.amazon.awscdk.core.*;
 Authorizer authorizer;
 Integration integration;
 Model model;
 RequestValidator requestValidator;
 RestApi restApi;
 ApiKeyProps apiKeyProps = ApiKeyProps.builder()
         .apiKeyName("apiKeyName")
         .customerId("customerId")
         .defaultCorsPreflightOptions(CorsOptions.builder()
                 .allowOrigins(List.of("allowOrigins"))
                 // the properties below are optional
                 .allowCredentials(false)
                 .allowHeaders(List.of("allowHeaders"))
                 .allowMethods(List.of("allowMethods"))
                 .disableCache(false)
                 .exposeHeaders(List.of("exposeHeaders"))
                 .maxAge(Duration.minutes(30))
                 .statusCode(123)
                 .build())
         .defaultIntegration(integration)
         .defaultMethodOptions(MethodOptions.builder()
                 .apiKeyRequired(false)
                 .authorizationScopes(List.of("authorizationScopes"))
                 .authorizationType(AuthorizationType.NONE)
                 .authorizer(authorizer)
                 .methodResponses(List.of(MethodResponse.builder()
                         .statusCode("statusCode")
                         // the properties below are optional
                         .responseModels(Map.of(
                                 "responseModelsKey", model))
                         .responseParameters(Map.of(
                                 "responseParametersKey", false))
                         .build()))
                 .operationName("operationName")
                 .requestModels(Map.of(
                         "requestModelsKey", model))
                 .requestParameters(Map.of(
                         "requestParametersKey", false))
                 .requestValidator(requestValidator)
                 .requestValidatorOptions(RequestValidatorOptions.builder()
                         .requestValidatorName("requestValidatorName")
                         .validateRequestBody(false)
                         .validateRequestParameters(false)
                         .build())
                 .build())
         .description("description")
         .enabled(false)
         .generateDistinctId(false)
         .resources(List.of(restApi))
         .value("value")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ApiKeyProps.Builder	builder()
default java.lang.String	getCustomerId() An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
default java.lang.Boolean	getEnabled() Indicates whether the API key can be used by clients.
default java.lang.Boolean	getGenerateDistinctId() Specifies whether the key identifier is distinct from the created API key value.
default java.util.List<IRestApi>	getResources() A list of resources this api key is associated with.

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

getApiKeyName, getDescription, getValue

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

getDefaultCorsPreflightOptions, getDefaultIntegration, getDefaultMethodOptions

Method Detail

getCustomerId

default java.lang.String getCustomerId()

An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.

Default: none

getEnabled

default java.lang.Boolean getEnabled()

Indicates whether the API key can be used by clients.

Default: true

getGenerateDistinctId

default java.lang.Boolean getGenerateDistinctId()

Specifies whether the key identifier is distinct from the created API key value.

Default: false

getResources

default java.util.List<IRestApi> getResources()

A list of resources this api key is associated with.

Default: none

builder

static ApiKeyProps.Builder builder()

Specified by:

builder in interface ApiKeyOptions

Specified by:

builder in interface ResourceOptions

Returns:

a ApiKeyProps.Builder of ApiKeyProps