Package 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(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	Description
CfnStage.Builder	accessLogSetting(IResolvable accessLogSetting)	Access log settings, including the access log format and access log destination ARN.
CfnStage.Builder	accessLogSetting(CfnStage.AccessLogSettingProperty accessLogSetting)	Access log settings, including the access log format and access log destination ARN.
CfnStage	build()
CfnStage.Builder	cacheClusterEnabled(Boolean cacheClusterEnabled)	Specifies whether a cache cluster is enabled for the stage.
CfnStage.Builder	cacheClusterEnabled(IResolvable cacheClusterEnabled)	Specifies whether a cache cluster is enabled for the stage.
CfnStage.Builder	cacheClusterSize(String cacheClusterSize)	The stage's cache capacity in GB.
CfnStage.Builder	canarySetting(IResolvable canarySetting)	Settings for the canary deployment in this stage.
CfnStage.Builder	canarySetting(CfnStage.CanarySettingProperty canarySetting)	Settings for the canary deployment in this stage.
CfnStage.Builder	clientCertificateId(String clientCertificateId)	The identifier of a client certificate for an API stage.
static CfnStage.Builder	create(software.constructs.Construct scope, String id)
CfnStage.Builder	deploymentId(String deploymentId)	The identifier of the Deployment that the stage points to.
CfnStage.Builder	description(String description)	The stage's description.
CfnStage.Builder	documentationVersion(String documentationVersion)	The version of the associated API documentation.
CfnStage.Builder	methodSettings(List<? extends Object> methodSettings)	A map that defines the method settings for a Stage resource.
CfnStage.Builder	methodSettings(IResolvable methodSettings)	A map that defines the method settings for a Stage resource.
CfnStage.Builder	restApiId(String restApiId)	The string identifier of the associated RestApi.
CfnStage.Builder	stageName(String stageName)	The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.
CfnStage.Builder	tags(List<? extends CfnTag> tags)	The collection of tags.
CfnStage.Builder	tracingEnabled(Boolean tracingEnabled)	Specifies whether active tracing with X-ray is enabled for the Stage.
CfnStage.Builder	tracingEnabled(IResolvable tracingEnabled)	Specifies whether active tracing with X-ray is enabled for the Stage.
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.
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.

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

restApiId

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

The string identifier of the associated RestApi.

Parameters:

restApiId - The string identifier of the associated RestApi. This parameter is required.

Returns:

this

See Also:

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

accessLogSetting

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

Access log settings, including the access log format and access log destination ARN.

Parameters:

accessLogSetting - Access log settings, including the access log format and access log destination ARN. This parameter is required.

Returns:

this

See Also:

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

accessLogSetting

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

Access log settings, including the access log format and access log destination ARN.

Parameters:

accessLogSetting - Access log settings, including the access log format and access log destination ARN. This parameter is required.

Returns:

this

See Also:

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

cacheClusterEnabled

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

Specifies whether a cache cluster is enabled for the stage.

To activate a method-level cache, set CachingEnabled to true for a method.

Parameters:

cacheClusterEnabled - Specifies whether a cache cluster is enabled for the stage. This parameter is required.

Returns:

this

See Also:

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

cacheClusterEnabled

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

Specifies whether a cache cluster is enabled for the stage.

To activate a method-level cache, set CachingEnabled to true for a method.

Parameters:

cacheClusterEnabled - Specifies whether a cache cluster is enabled for the stage. This parameter is required.

Returns:

this

See Also:

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

cacheClusterSize

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

The stage's cache capacity in GB.

For more information about choosing a cache size, see Enabling API caching to enhance responsiveness .

Parameters:

cacheClusterSize - The stage's cache capacity in GB. This parameter is required.

Returns:

this

See Also:

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

canarySetting

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

Settings for the canary deployment in this stage.

Parameters:

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

Returns:

this

See Also:

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

canarySetting

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

Settings for the canary deployment in this stage.

Parameters:

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

Returns:

this

See Also:

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

clientCertificateId

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

The identifier of a client certificate for an API stage.

Parameters:

clientCertificateId - The identifier of a client certificate for an API stage. This parameter is required.

Returns:

this

See Also:

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

deploymentId

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

The identifier of the Deployment that the stage points to.

Parameters:

deploymentId - The identifier of the Deployment that the stage points to. This parameter is required.

Returns:

this

See Also:

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

description

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

The stage's description.

Parameters:

description - The stage's description. This parameter is required.

Returns:

this

See Also:

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

documentationVersion

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

The version of the associated API documentation.

Parameters:

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

Returns:

this

See Also:

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

methodSettings

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

A map that defines the method settings for a Stage resource.

Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\* /\* for overriding all methods in the stage.

Parameters:

methodSettings - A map that defines the method settings for a Stage resource. This parameter is required.

Returns:

this

See Also:

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

methodSettings

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

A map that defines the method settings for a Stage resource.

Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\* /\* for overriding all methods in the stage.

Parameters:

methodSettings - A map that defines the method settings for a Stage resource. This parameter is required.

Returns:

this

See Also:

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

stageName

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

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.

Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Parameters:

stageName - The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. This parameter is required.

Returns:

this

See Also:

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

tags

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

The collection of tags.

Each tag element is associated with a given resource.

Parameters:

tags - The collection of tags. This parameter is required.

Returns:

this

See Also:

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

tracingEnabled

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

Specifies whether active tracing with X-ray is enabled for the Stage.

Parameters:

tracingEnabled - Specifies whether active tracing with X-ray is enabled for the Stage. This parameter is required.

Returns:

this

See Also:

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

tracingEnabled

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

Specifies whether active tracing with X-ray is enabled for the Stage.

Parameters:

tracingEnabled - Specifies whether active tracing with X-ray is enabled for the Stage. This parameter is required.

Returns:

this

See Also:

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

variables

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

See Also:

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

variables

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

See Also:

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

build

@Stability(Stable)
public CfnStage build()

Specified by:

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

Returns:

a newly built instance of CfnStage.