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) `AWS::ApiGateway::ApiKey.CustomerId`.
CfnApiKey.Builder	description(String description) `AWS::ApiGateway::ApiKey.Description`.
CfnApiKey.Builder	enabled(Boolean enabled) `AWS::ApiGateway::ApiKey.Enabled`.
CfnApiKey.Builder	enabled(IResolvable enabled) `AWS::ApiGateway::ApiKey.Enabled`.
CfnApiKey.Builder	generateDistinctId(Boolean generateDistinctId) `AWS::ApiGateway::ApiKey.GenerateDistinctId`.
CfnApiKey.Builder	generateDistinctId(IResolvable generateDistinctId) `AWS::ApiGateway::ApiKey.GenerateDistinctId`.
CfnApiKey.Builder	name(String name) `AWS::ApiGateway::ApiKey.Name`.
CfnApiKey.Builder	stageKeys(IResolvable stageKeys) `AWS::ApiGateway::ApiKey.StageKeys`.
CfnApiKey.Builder	stageKeys(List<? extends Object> stageKeys) `AWS::ApiGateway::ApiKey.StageKeys`.
CfnApiKey.Builder	tags(List<? extends CfnTag> tags) `AWS::ApiGateway::ApiKey.Tags`.
CfnApiKey.Builder	value(String value) `AWS::ApiGateway::ApiKey.Value`.

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)

`AWS::ApiGateway::ApiKey.CustomerId`.

Parameters:

customerId - `AWS::ApiGateway::ApiKey.CustomerId`. This parameter is required.

Returns:

this

description

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

`AWS::ApiGateway::ApiKey.Description`.

Parameters:

description - `AWS::ApiGateway::ApiKey.Description`. This parameter is required.

Returns:

this

enabled

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

`AWS::ApiGateway::ApiKey.Enabled`.

Parameters:

enabled - `AWS::ApiGateway::ApiKey.Enabled`. This parameter is required.

Returns:

this

enabled

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

`AWS::ApiGateway::ApiKey.Enabled`.

Parameters:

enabled - `AWS::ApiGateway::ApiKey.Enabled`. This parameter is required.

Returns:

this

generateDistinctId

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

`AWS::ApiGateway::ApiKey.GenerateDistinctId`.

Parameters:

generateDistinctId - `AWS::ApiGateway::ApiKey.GenerateDistinctId`. This parameter is required.

Returns:

this

generateDistinctId

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

`AWS::ApiGateway::ApiKey.GenerateDistinctId`.

Parameters:

generateDistinctId - `AWS::ApiGateway::ApiKey.GenerateDistinctId`. This parameter is required.

Returns:

this

name

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

`AWS::ApiGateway::ApiKey.Name`.

Parameters:

name - `AWS::ApiGateway::ApiKey.Name`. This parameter is required.

Returns:

this

stageKeys

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

`AWS::ApiGateway::ApiKey.StageKeys`.

Parameters:

stageKeys - `AWS::ApiGateway::ApiKey.StageKeys`. This parameter is required.

Returns:

this

stageKeys

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

`AWS::ApiGateway::ApiKey.StageKeys`.

Parameters:

stageKeys - `AWS::ApiGateway::ApiKey.StageKeys`. This parameter is required.

Returns:

this

tags

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

`AWS::ApiGateway::ApiKey.Tags`.

Parameters:

tags - `AWS::ApiGateway::ApiKey.Tags`. This parameter is required.

Returns:

this

value

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

`AWS::ApiGateway::ApiKey.Value`.

Parameters:

value - `AWS::ApiGateway::ApiKey.Value`. This parameter is required.

Returns:

this

build

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

Specified by:

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