software.amazon.awscdk.services.apigateway

Class ApiKey.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.ApiKey.Builder

Enclosing class:

ApiKey

public static final class ApiKey.Builder
extends java.lang.Object

A fluent builder for ApiKey.

Method Summary

Modifier and Type	Method and Description
ApiKey.Builder	apiKeyName(java.lang.String apiKeyName) A name for the API key.
ApiKey	build()
static ApiKey.Builder	create(software.constructs.Construct scope, java.lang.String id)
ApiKey.Builder	customerId(java.lang.String customerId) An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
ApiKey.Builder	defaultCorsPreflightOptions(CorsOptions defaultCorsPreflightOptions) Adds a CORS preflight OPTIONS method to this resource and all child resources.
ApiKey.Builder	defaultIntegration(Integration defaultIntegration) An integration to use as a default for all methods created within this API unless an integration is specified.
ApiKey.Builder	defaultMethodOptions(MethodOptions defaultMethodOptions) Method options to use as a default for all methods created within this API unless custom options are specified.
ApiKey.Builder	description(java.lang.String description) A description of the purpose of the API key.
ApiKey.Builder	enabled(java.lang.Boolean enabled) Indicates whether the API key can be used by clients.
ApiKey.Builder	generateDistinctId(java.lang.Boolean generateDistinctId) Specifies whether the key identifier is distinct from the created API key value.
ApiKey.Builder	resources(java.util.List<? extends IRestApi> resources) A list of resources this api key is associated with.
ApiKey.Builder	value(java.lang.String value) The value of the API key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static ApiKey.Builder create(software.constructs.Construct scope,
                                    java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of ApiKey.Builder.

defaultCorsPreflightOptions

public ApiKey.Builder defaultCorsPreflightOptions(CorsOptions defaultCorsPreflightOptions)

Adds a CORS preflight OPTIONS method to this resource and all child resources.

You can add CORS at the resource-level using addCorsPreflight.

Default: - CORS is disabled

Parameters:

defaultCorsPreflightOptions - Adds a CORS preflight OPTIONS method to this resource and all child resources. This parameter is required.

Returns:

this

defaultIntegration

public ApiKey.Builder defaultIntegration(Integration defaultIntegration)

An integration to use as a default for all methods created within this API unless an integration is specified.

Default: - Inherited from parent.

Parameters:

defaultIntegration - An integration to use as a default for all methods created within this API unless an integration is specified. This parameter is required.

Returns:

this

defaultMethodOptions

public ApiKey.Builder defaultMethodOptions(MethodOptions defaultMethodOptions)

Method options to use as a default for all methods created within this API unless custom options are specified.

Default: - Inherited from parent.

Parameters:

defaultMethodOptions - Method options to use as a default for all methods created within this API unless custom options are specified. This parameter is required.

Returns:

this

apiKeyName

public ApiKey.Builder apiKeyName(java.lang.String apiKeyName)

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

Parameters:

apiKeyName - A name for the API key. This parameter is required.

Returns:

this

description

public ApiKey.Builder description(java.lang.String description)

A description of the purpose of the API key.

Default: none

Parameters:

description - A description of the purpose of the API key. This parameter is required.

Returns:

this

value

public ApiKey.Builder value(java.lang.String value)

The value of the API key.

Must be at least 20 characters long.

Default: none

Parameters:

value - The value of the API key. This parameter is required.

Returns:

this

customerId

public ApiKey.Builder customerId(java.lang.String customerId)

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

Default: none

Parameters:

customerId - An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace. This parameter is required.

Returns:

this

enabled

public ApiKey.Builder enabled(java.lang.Boolean enabled)

Indicates whether the API key can be used by clients.

Default: true

Parameters:

enabled - Indicates whether the API key can be used by clients. This parameter is required.

Returns:

this

generateDistinctId

public ApiKey.Builder generateDistinctId(java.lang.Boolean generateDistinctId)

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

Default: false

Parameters:

generateDistinctId - Specifies whether the key identifier is distinct from the created API key value. This parameter is required.

Returns:

this

resources

public ApiKey.Builder resources(java.util.List<? extends IRestApi> resources)

A list of resources this api key is associated with.

Default: none

Parameters:

resources - A list of resources this api key is associated with. This parameter is required.

Returns:

this

build

public ApiKey build()