Package software.amazon.awscdk.services.apigateway

Class CfnApiKeyProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnApiKeyProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnApiKeyProps>

Enclosing interface:

CfnApiKeyProps

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

A builder for CfnApiKeyProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnApiKeyProps	build()	Builds the configured instance.
CfnApiKeyProps.Builder	customerId(String customerId)	Sets the value of CfnApiKeyProps.getCustomerId()
CfnApiKeyProps.Builder	description(String description)	Sets the value of CfnApiKeyProps.getDescription()
CfnApiKeyProps.Builder	enabled(Boolean enabled)	Sets the value of CfnApiKeyProps.getEnabled()
CfnApiKeyProps.Builder	enabled(IResolvable enabled)	Sets the value of CfnApiKeyProps.getEnabled()
CfnApiKeyProps.Builder	generateDistinctId(Boolean generateDistinctId)	Sets the value of CfnApiKeyProps.getGenerateDistinctId()
CfnApiKeyProps.Builder	generateDistinctId(IResolvable generateDistinctId)	Sets the value of CfnApiKeyProps.getGenerateDistinctId()
CfnApiKeyProps.Builder	name(String name)	Sets the value of CfnApiKeyProps.getName()
CfnApiKeyProps.Builder	stageKeys(List<? extends Object> stageKeys)	Sets the value of CfnApiKeyProps.getStageKeys()
CfnApiKeyProps.Builder	stageKeys(IResolvable stageKeys)	Sets the value of CfnApiKeyProps.getStageKeys()
CfnApiKeyProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnApiKeyProps.getTags()
CfnApiKeyProps.Builder	value(String value)	Sets the value of CfnApiKeyProps.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 CfnApiKeyProps.Builder customerId(String customerId)

Sets the value of CfnApiKeyProps.getCustomerId()

Parameters:

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

Returns:

this

description

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

Sets the value of CfnApiKeyProps.getDescription()

Parameters:

description - The description of the ApiKey.

Returns:

this

enabled

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

Sets the value of CfnApiKeyProps.getEnabled()

Parameters:

enabled - Specifies whether the ApiKey can be used by callers.

Returns:

this

enabled

@Stability(Stable)
public CfnApiKeyProps.Builder enabled(IResolvable enabled)

Sets the value of CfnApiKeyProps.getEnabled()

Parameters:

enabled - Specifies whether the ApiKey can be used by callers.

Returns:

this

generateDistinctId

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

Sets the value of CfnApiKeyProps.getGenerateDistinctId()

Parameters:

generateDistinctId - Specifies whether ( true ) or not ( false ) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.

Returns:

this

generateDistinctId

@Stability(Stable)
public CfnApiKeyProps.Builder generateDistinctId(IResolvable generateDistinctId)

Sets the value of CfnApiKeyProps.getGenerateDistinctId()

Parameters:

generateDistinctId - Specifies whether ( true ) or not ( false ) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.

Returns:

this

name

@Stability(Stable)
public CfnApiKeyProps.Builder name(String name)

Sets the value of CfnApiKeyProps.getName()

Parameters:

name - 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. For more information, see Name Type .

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

Returns:

this

stageKeys

@Stability(Stable)
public CfnApiKeyProps.Builder stageKeys(IResolvable stageKeys)

Sets the value of CfnApiKeyProps.getStageKeys()

Parameters:

stageKeys - DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

Returns:

this

stageKeys

@Stability(Stable)
public CfnApiKeyProps.Builder stageKeys(List<? extends Object> stageKeys)

Sets the value of CfnApiKeyProps.getStageKeys()

Parameters:

stageKeys - DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

Returns:

this

tags

@Stability(Stable)
public CfnApiKeyProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnApiKeyProps.getTags()

Parameters:

tags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws: . The tag value can be up to 256 characters.

Returns:

this

value

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

Sets the value of CfnApiKeyProps.getValue()

Parameters:

value - Specifies a value of the API key.

Returns:

this

build

@Stability(Stable)
public CfnApiKeyProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnApiKeyProps

Throws:

NullPointerException - if any required attribute was not provided