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) Specifies settings for logging access in this stage.
CfnStage.Builder	accessLogSetting(IResolvable accessLogSetting) Specifies settings for logging access in this stage.
CfnStage	build()
CfnStage.Builder	cacheClusterEnabled(Boolean cacheClusterEnabled) Indicates whether cache clustering is enabled for the stage.
CfnStage.Builder	cacheClusterEnabled(IResolvable cacheClusterEnabled) Indicates whether cache clustering is enabled for the stage.
CfnStage.Builder	cacheClusterSize(String cacheClusterSize) The stage's cache cluster size.
CfnStage.Builder	canarySetting(CfnStage.CanarySettingProperty canarySetting) Specifies settings for the canary deployment in this stage.
CfnStage.Builder	canarySetting(IResolvable canarySetting) Specifies settings for the canary deployment in this stage.
CfnStage.Builder	clientCertificateId(String clientCertificateId) The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.
static CfnStage.Builder	create(software.constructs.Construct scope, String id)
CfnStage.Builder	deploymentId(String deploymentId) The ID of the deployment that the stage is associated with.
CfnStage.Builder	description(String description) A description of the stage.
CfnStage.Builder	documentationVersion(String documentationVersion) The version ID of the API documentation snapshot.
CfnStage.Builder	methodSettings(IResolvable methodSettings) Settings for all methods in the stage.
CfnStage.Builder	methodSettings(List<? extends Object> methodSettings) Settings for all methods in the stage.
CfnStage.Builder	restApiId(String restApiId) The ID of the `RestApi` resource that you're deploying with this stage.
CfnStage.Builder	stageName(String stageName) The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
CfnStage.Builder	tags(List<? extends CfnTag> tags) An array of arbitrary tags (key-value pairs) to associate with the stage.
CfnStage.Builder	tracingEnabled(Boolean tracingEnabled) Specifies whether active X-Ray tracing is enabled for this stage.
CfnStage.Builder	tracingEnabled(IResolvable tracingEnabled) Specifies whether active X-Ray tracing is enabled for this stage.
CfnStage.Builder	variables(IResolvable variables) A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value.
CfnStage.Builder	variables(Map<String,String> variables) A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the 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 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)

The ID of the `RestApi` resource that you're deploying with this stage.

Parameters:

restApiId - The ID of the `RestApi` resource that you're deploying with this stage. This parameter is required.

Returns:

this

accessLogSetting

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

Specifies settings for logging access in this stage.

Parameters:

accessLogSetting - Specifies settings for logging access in this stage. This parameter is required.

Returns:

this

accessLogSetting

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

Specifies settings for logging access in this stage.

Parameters:

accessLogSetting - Specifies settings for logging access in this stage. This parameter is required.

Returns:

this

cacheClusterEnabled

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

Indicates whether cache clustering is enabled for the stage.

Parameters:

cacheClusterEnabled - Indicates whether cache clustering is enabled for the stage. This parameter is required.

Returns:

this

cacheClusterEnabled

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

Indicates whether cache clustering is enabled for the stage.

Parameters:

cacheClusterEnabled - Indicates whether cache clustering is enabled for the stage. This parameter is required.

Returns:

this

cacheClusterSize

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

The stage's cache cluster size.

Parameters:

cacheClusterSize - The stage's cache cluster size. This parameter is required.

Returns:

this

canarySetting

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

Specifies settings for the canary deployment in this stage.

Parameters:

canarySetting - Specifies settings for the canary deployment in this stage. This parameter is required.

Returns:

this

canarySetting

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

Specifies settings for the canary deployment in this stage.

Parameters:

canarySetting - Specifies settings for the canary deployment in this stage. This parameter is required.

Returns:

this

clientCertificateId

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

The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.

Parameters:

clientCertificateId - The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage. This parameter is required.

Returns:

this

deploymentId

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

The ID of the deployment that the stage is associated with.

This parameter is required to create a stage.

Parameters:

deploymentId - The ID of the deployment that the stage is associated with. This parameter is required.

Returns:

this

description

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

A description of the stage.

Parameters:

description - A description of the stage. This parameter is required.

Returns:

this

documentationVersion

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

The version ID of the API documentation snapshot.

Parameters:

documentationVersion - The version ID of the API documentation snapshot. This parameter is required.

Returns:

this

methodSettings

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

Settings for all methods in the stage.

Parameters:

methodSettings - Settings for all methods in the stage. This parameter is required.

Returns:

this

methodSettings

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

Settings for all methods in the stage.

Parameters:

methodSettings - Settings for all methods in the stage. This parameter is required.

Returns:

this

stageName

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

The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).

Parameters:

stageName - The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI). This parameter is required.

Returns:

this

tags

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

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

Parameters:

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

Returns:

this

tracingEnabled

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

Specifies whether active X-Ray tracing is enabled for this stage.

For more information, see Trace API Gateway API Execution with AWS X-Ray in the API Gateway Developer Guide .

Parameters:

tracingEnabled - Specifies whether active X-Ray tracing is enabled for this stage. This parameter is required.

Returns:

this

tracingEnabled

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

Specifies whether active X-Ray tracing is enabled for this stage.

For more information, see Trace API Gateway API Execution with AWS X-Ray in the API Gateway Developer Guide .

Parameters:

tracingEnabled - Specifies whether active X-Ray tracing is enabled for this stage. This parameter is required.

Returns:

this

variables

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

A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value.

Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+ .

Parameters:

variables - A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. This parameter is required.

Returns:

this

variables

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

A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value.

Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+ .

Parameters:

variables - A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. This parameter is required.

Returns:

this

build

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

Specified by:

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