Package software.amazon.awscdk.services.apigatewayv2

Class ApiKeyProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.ApiKeyProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ApiKeyProps>

Enclosing interface:

ApiKeyProps

@Stability(Stable)
public static final class ApiKeyProps.Builder
extends Object
implements software.amazon.jsii.Builder<ApiKeyProps>

A builder for ApiKeyProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ApiKeyProps.Builder	apiKeyName(String apiKeyName)	Sets the value of ApiKeyOptions.getApiKeyName()
ApiKeyProps	build()	Builds the configured instance.
ApiKeyProps.Builder	customerId(String customerId)	Sets the value of ApiKeyProps.getCustomerId()
ApiKeyProps.Builder	description(String description)	Sets the value of ApiKeyOptions.getDescription()
ApiKeyProps.Builder	enabled(Boolean enabled)	Sets the value of ApiKeyProps.getEnabled()
ApiKeyProps.Builder	generateDistinctId(Boolean generateDistinctId)	Sets the value of ApiKeyProps.getGenerateDistinctId()
ApiKeyProps.Builder	value(String value)	Sets the value of ApiKeyOptions.getValue()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

customerId

@Stability(Stable)
public ApiKeyProps.Builder customerId(String customerId)

Sets the value of ApiKeyProps.getCustomerId()

Parameters:

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

Returns:

this

enabled

@Stability(Stable)
public ApiKeyProps.Builder enabled(Boolean enabled)

Sets the value of ApiKeyProps.getEnabled()

Parameters:

enabled - Indicates whether the API key can be used by clients.

Returns:

this

generateDistinctId

@Stability(Stable)
public ApiKeyProps.Builder generateDistinctId(Boolean generateDistinctId)

Sets the value of ApiKeyProps.getGenerateDistinctId()

Parameters:

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

Returns:

this

apiKeyName

@Stability(Stable)
public ApiKeyProps.Builder apiKeyName(String apiKeyName)

Sets the value of ApiKeyOptions.getApiKeyName()

Parameters:

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.

Returns:

this

description

@Stability(Stable)
public ApiKeyProps.Builder description(String description)

Sets the value of ApiKeyOptions.getDescription()

Parameters:

description - A description of the purpose of the API key.

Returns:

this

value

@Stability(Stable)
public ApiKeyProps.Builder value(String value)

Sets the value of ApiKeyOptions.getValue()

Parameters:

value - The value of the API key. Must be at least 20 characters long.

Returns:

this

build

@Stability(Stable)
public ApiKeyProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ApiKeyProps>

Returns:

a new instance of ApiKeyProps

Throws:

NullPointerException - if any required attribute was not provided