software.amazon.awscdk.services.apigateway

Class CfnStage.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnStage.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnStage>

Enclosing class:

CfnStage

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

A fluent builder for CfnStage.

Method Summary

Modifier and Type	Method and Description
CfnStage.Builder	accessLogSetting(CfnStage.AccessLogSettingProperty accessLogSetting) `AWS::ApiGateway::Stage.AccessLogSetting`.
CfnStage.Builder	accessLogSetting(IResolvable accessLogSetting) `AWS::ApiGateway::Stage.AccessLogSetting`.
CfnStage	build()
CfnStage.Builder	cacheClusterEnabled(Boolean cacheClusterEnabled) `AWS::ApiGateway::Stage.CacheClusterEnabled`.
CfnStage.Builder	cacheClusterEnabled(IResolvable cacheClusterEnabled) `AWS::ApiGateway::Stage.CacheClusterEnabled`.
CfnStage.Builder	cacheClusterSize(String cacheClusterSize) `AWS::ApiGateway::Stage.CacheClusterSize`.
CfnStage.Builder	canarySetting(CfnStage.CanarySettingProperty canarySetting) `AWS::ApiGateway::Stage.CanarySetting`.
CfnStage.Builder	canarySetting(IResolvable canarySetting) `AWS::ApiGateway::Stage.CanarySetting`.
CfnStage.Builder	clientCertificateId(String clientCertificateId) `AWS::ApiGateway::Stage.ClientCertificateId`.
static CfnStage.Builder	create(software.constructs.Construct scope, String id)
CfnStage.Builder	deploymentId(String deploymentId) `AWS::ApiGateway::Stage.DeploymentId`.
CfnStage.Builder	description(String description) `AWS::ApiGateway::Stage.Description`.
CfnStage.Builder	documentationVersion(String documentationVersion) `AWS::ApiGateway::Stage.DocumentationVersion`.
CfnStage.Builder	methodSettings(IResolvable methodSettings) `AWS::ApiGateway::Stage.MethodSettings`.
CfnStage.Builder	methodSettings(List<? extends Object> methodSettings) `AWS::ApiGateway::Stage.MethodSettings`.
CfnStage.Builder	restApiId(String restApiId) `AWS::ApiGateway::Stage.RestApiId`.
CfnStage.Builder	stageName(String stageName) `AWS::ApiGateway::Stage.StageName`.
CfnStage.Builder	tags(List<? extends CfnTag> tags) `AWS::ApiGateway::Stage.Tags`.
CfnStage.Builder	tracingEnabled(Boolean tracingEnabled) `AWS::ApiGateway::Stage.TracingEnabled`.
CfnStage.Builder	tracingEnabled(IResolvable tracingEnabled) `AWS::ApiGateway::Stage.TracingEnabled`.
CfnStage.Builder	variables(IResolvable variables) `AWS::ApiGateway::Stage.Variables`.
CfnStage.Builder	variables(Map<String,String> variables) `AWS::ApiGateway::Stage.Variables`.

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 CfnStage.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 CfnStage.AccessLogSettingProperty.Builder.

restApiId

@Stability(value=Stable)
public CfnStage.Builder restApiId(String restApiId)

`AWS::ApiGateway::Stage.RestApiId`.

Parameters:

restApiId - `AWS::ApiGateway::Stage.RestApiId`. This parameter is required.

Returns:

this

accessLogSetting

@Stability(value=Stable)
public CfnStage.Builder accessLogSetting(CfnStage.AccessLogSettingProperty accessLogSetting)

`AWS::ApiGateway::Stage.AccessLogSetting`.

Parameters:

accessLogSetting - `AWS::ApiGateway::Stage.AccessLogSetting`. This parameter is required.

Returns:

this

accessLogSetting

@Stability(value=Stable)
public CfnStage.Builder accessLogSetting(IResolvable accessLogSetting)

`AWS::ApiGateway::Stage.AccessLogSetting`.

Parameters:

accessLogSetting - `AWS::ApiGateway::Stage.AccessLogSetting`. This parameter is required.

Returns:

this

cacheClusterEnabled

@Stability(value=Stable)
public CfnStage.Builder cacheClusterEnabled(Boolean cacheClusterEnabled)

`AWS::ApiGateway::Stage.CacheClusterEnabled`.

Parameters:

cacheClusterEnabled - `AWS::ApiGateway::Stage.CacheClusterEnabled`. This parameter is required.

Returns:

this

cacheClusterEnabled

@Stability(value=Stable)
public CfnStage.Builder cacheClusterEnabled(IResolvable cacheClusterEnabled)

`AWS::ApiGateway::Stage.CacheClusterEnabled`.

Parameters:

cacheClusterEnabled - `AWS::ApiGateway::Stage.CacheClusterEnabled`. This parameter is required.

Returns:

this

cacheClusterSize

@Stability(value=Stable)
public CfnStage.Builder cacheClusterSize(String cacheClusterSize)

`AWS::ApiGateway::Stage.CacheClusterSize`.

Parameters:

cacheClusterSize - `AWS::ApiGateway::Stage.CacheClusterSize`. This parameter is required.

Returns:

this

canarySetting

@Stability(value=Stable)
public CfnStage.Builder canarySetting(CfnStage.CanarySettingProperty canarySetting)

`AWS::ApiGateway::Stage.CanarySetting`.

Parameters:

canarySetting - `AWS::ApiGateway::Stage.CanarySetting`. This parameter is required.

Returns:

this

canarySetting

@Stability(value=Stable)
public CfnStage.Builder canarySetting(IResolvable canarySetting)

`AWS::ApiGateway::Stage.CanarySetting`.

Parameters:

canarySetting - `AWS::ApiGateway::Stage.CanarySetting`. This parameter is required.

Returns:

this

clientCertificateId

@Stability(value=Stable)
public CfnStage.Builder clientCertificateId(String clientCertificateId)

`AWS::ApiGateway::Stage.ClientCertificateId`.

Parameters:

clientCertificateId - `AWS::ApiGateway::Stage.ClientCertificateId`. This parameter is required.

Returns:

this

deploymentId

@Stability(value=Stable)
public CfnStage.Builder deploymentId(String deploymentId)

`AWS::ApiGateway::Stage.DeploymentId`.

Parameters:

deploymentId - `AWS::ApiGateway::Stage.DeploymentId`. This parameter is required.

Returns:

this

description

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

`AWS::ApiGateway::Stage.Description`.

Parameters:

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

Returns:

this

documentationVersion

@Stability(value=Stable)
public CfnStage.Builder documentationVersion(String documentationVersion)

`AWS::ApiGateway::Stage.DocumentationVersion`.

Parameters:

documentationVersion - `AWS::ApiGateway::Stage.DocumentationVersion`. This parameter is required.

Returns:

this

methodSettings

@Stability(value=Stable)
public CfnStage.Builder methodSettings(IResolvable methodSettings)

`AWS::ApiGateway::Stage.MethodSettings`.

Parameters:

methodSettings - `AWS::ApiGateway::Stage.MethodSettings`. This parameter is required.

Returns:

this

methodSettings

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

`AWS::ApiGateway::Stage.MethodSettings`.

Parameters:

methodSettings - `AWS::ApiGateway::Stage.MethodSettings`. This parameter is required.

Returns:

this

stageName

@Stability(value=Stable)
public CfnStage.Builder stageName(String stageName)

`AWS::ApiGateway::Stage.StageName`.

Parameters:

stageName - `AWS::ApiGateway::Stage.StageName`. This parameter is required.

Returns:

this

tags

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

`AWS::ApiGateway::Stage.Tags`.

Parameters:

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

Returns:

this

tracingEnabled

@Stability(value=Stable)
public CfnStage.Builder tracingEnabled(Boolean tracingEnabled)

`AWS::ApiGateway::Stage.TracingEnabled`.

Parameters:

tracingEnabled - `AWS::ApiGateway::Stage.TracingEnabled`. This parameter is required.

Returns:

this

tracingEnabled

@Stability(value=Stable)
public CfnStage.Builder tracingEnabled(IResolvable tracingEnabled)

`AWS::ApiGateway::Stage.TracingEnabled`.

Parameters:

tracingEnabled - `AWS::ApiGateway::Stage.TracingEnabled`. This parameter is required.

Returns:

this

variables

@Stability(value=Stable)
public CfnStage.Builder variables(IResolvable variables)

`AWS::ApiGateway::Stage.Variables`.

Parameters:

variables - `AWS::ApiGateway::Stage.Variables`. This parameter is required.

Returns:

this

variables

@Stability(value=Stable)
public CfnStage.Builder variables(Map<String,String> variables)

`AWS::ApiGateway::Stage.Variables`.

Parameters:

variables - `AWS::ApiGateway::Stage.Variables`. This parameter is required.

Returns:

this

build

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

Specified by:

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