Package 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(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	Description
CfnApiKey	build()
static CfnApiKey.Builder	create(software.constructs.Construct scope, String id)
CfnApiKey.Builder	customerId(String customerId)	An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace.
CfnApiKey.Builder	description(String description)	The description of the ApiKey.
CfnApiKey.Builder	enabled(Boolean enabled)	Specifies whether the ApiKey can be used by callers.
CfnApiKey.Builder	enabled(IResolvable enabled)	Specifies whether the ApiKey can be used by callers.
CfnApiKey.Builder	generateDistinctId(Boolean generateDistinctId)	Specifies whether ( true ) or not ( false ) the key identifier is distinct from the created API key value.
CfnApiKey.Builder	generateDistinctId(IResolvable generateDistinctId)	Specifies whether ( true ) or not ( false ) 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(List<? extends Object> stageKeys)	DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
CfnApiKey.Builder	stageKeys(IResolvable stageKeys)	DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
CfnApiKey.Builder	tags(List<? extends CfnTag> tags)	The key-value map of strings.
CfnApiKey.Builder	value(String value)	Specifies a value of the API key.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(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 - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnApiKey.Builder.

customerId

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-customerid

description

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

The description of the ApiKey.

Parameters:

description - The description of the ApiKey. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-description

enabled

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

Specifies whether the ApiKey can be used by callers.

Default: - false

Parameters:

enabled - Specifies whether the ApiKey can be used by callers. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-enabled

enabled

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

Specifies whether the ApiKey can be used by callers.

Default: - false

Parameters:

enabled - Specifies whether the ApiKey can be used by callers. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-enabled

generateDistinctId

@Stability(Stable)
public CfnApiKey.Builder generateDistinctId(Boolean 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.

Parameters:

generateDistinctId - Specifies whether ( true ) or not ( false ) the key identifier is distinct from the created API key value. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-generatedistinctid

generateDistinctId

@Stability(Stable)
public CfnApiKey.Builder generateDistinctId(IResolvable 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.

Parameters:

generateDistinctId - Specifies whether ( true ) or not ( false ) the key identifier is distinct from the created API key value. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-generatedistinctid

name

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-name

stageKeys

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

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

Parameters:

stageKeys - DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-stagekeys

stageKeys

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

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

Parameters:

stageKeys - DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-stagekeys

tags

@Stability(Stable)
public CfnApiKey.Builder tags(List<? extends CfnTag> 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.

Parameters:

tags - The key-value map of strings. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-tags

value

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

Specifies a value of the API key.

Parameters:

value - Specifies a value of the API key. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-value

build

@Stability(Stable)
public CfnApiKey build()

Specified by:

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

Returns:

a newly built instance of CfnApiKey.