software.amazon.awscdk.services.apigateway

Class CfnApiKey.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnApiKey.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnApiKey>

Enclosing class:

CfnApiKey

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

A fluent builder for CfnApiKey.

Method Summary

Modifier and Type	Method and Description
CfnApiKey	build()
static CfnApiKey.Builder	create(software.constructs.Construct scope, String id)
CfnApiKey.Builder	customerId(String customerId) An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
CfnApiKey.Builder	description(String description) A description of the purpose of the API key.
CfnApiKey.Builder	enabled(Boolean enabled) Indicates whether the API key can be used by clients.
CfnApiKey.Builder	enabled(IResolvable enabled) Indicates whether the API key can be used by clients.
CfnApiKey.Builder	generateDistinctId(Boolean generateDistinctId) Specifies whether the key identifier is distinct from the created API key value.
CfnApiKey.Builder	generateDistinctId(IResolvable generateDistinctId) Specifies whether the key identifier is distinct from the created API key value.
CfnApiKey.Builder	name(String name) A name for the API key.
CfnApiKey.Builder	stageKeys(IResolvable stageKeys) A list of stages to associate with this API key.
CfnApiKey.Builder	stageKeys(List<? extends Object> stageKeys) A list of stages to associate with this API key.
CfnApiKey.Builder	tags(List<? extends CfnTag> tags) An array of arbitrary tags (key-value pairs) to associate with the API key.
CfnApiKey.Builder	value(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

@Stability(value=Stable)
public static CfnApiKey.Builder create(software.constructs.Construct scope,
                                                                String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnApiKey.StageKeyProperty.Builder.

customerId

@Stability(value=Stable)
public CfnApiKey.Builder customerId(String customerId)

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

Parameters:

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

Returns:

this

description

@Stability(value=Stable)
public CfnApiKey.Builder description(String description)

A description of the purpose of the API key.

Parameters:

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

Returns:

this

enabled

@Stability(value=Stable)
public CfnApiKey.Builder enabled(Boolean enabled)

Indicates whether the API key can be used by clients.

Parameters:

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

Returns:

this

enabled

@Stability(value=Stable)
public CfnApiKey.Builder enabled(IResolvable enabled)

Indicates whether the API key can be used by clients.

Parameters:

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

Returns:

this

generateDistinctId

@Stability(value=Stable)
public CfnApiKey.Builder generateDistinctId(Boolean generateDistinctId)

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

This parameter is deprecated and should not be used.

Parameters:

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

Returns:

this

generateDistinctId

@Stability(value=Stable)
public CfnApiKey.Builder generateDistinctId(IResolvable generateDistinctId)

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

This parameter is deprecated and should not be used.

Parameters:

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

Returns:

this

name

@Stability(value=Stable)
public CfnApiKey.Builder name(String 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.

Parameters:

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

Returns:

this

stageKeys

@Stability(value=Stable)
public CfnApiKey.Builder stageKeys(IResolvable stageKeys)

A list of stages to associate with this API key.

Parameters:

stageKeys - A list of stages to associate with this API key. This parameter is required.

Returns:

this

stageKeys

@Stability(value=Stable)
public CfnApiKey.Builder stageKeys(List<? extends Object> stageKeys)

A list of stages to associate with this API key.

Parameters:

stageKeys - A list of stages to associate with this API key. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnApiKey.Builder tags(List<? extends CfnTag> tags)

An array of arbitrary tags (key-value pairs) to associate with the API key.

Parameters:

tags - An array of arbitrary tags (key-value pairs) to associate with the API key. This parameter is required.

Returns:

this

value

@Stability(value=Stable)
public CfnApiKey.Builder value(String value)

The value of the API key.

Must be at least 20 characters long.

Parameters:

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

Returns:

this

build

@Stability(value=Stable)
public CfnApiKey build()

Specified by:

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