Package software.amazon.awscdk.services.apigatewayv2

Class CfnStage.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.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	accessLogSettings(IResolvable accessLogSettings)	Settings for logging access in this stage.
CfnStage.Builder	accessLogSettings(CfnStage.AccessLogSettingsProperty accessLogSettings)	Settings for logging access in this stage.
CfnStage.Builder	accessPolicyId(String accessPolicyId)	This parameter is not currently supported.
CfnStage.Builder	apiId(String apiId)	The API identifier.
CfnStage.Builder	autoDeploy(Boolean autoDeploy)	Specifies whether updates to an API automatically trigger a new deployment.
CfnStage.Builder	autoDeploy(IResolvable autoDeploy)	Specifies whether updates to an API automatically trigger a new deployment.
CfnStage	build()
CfnStage.Builder	clientCertificateId(String clientCertificateId)	The identifier of a client certificate for a Stage .
static CfnStage.Builder	create(software.constructs.Construct scope, String id)
CfnStage.Builder	defaultRouteSettings(IResolvable defaultRouteSettings)	The default route settings for the stage.
CfnStage.Builder	defaultRouteSettings(CfnStage.RouteSettingsProperty defaultRouteSettings)	The default route settings for the stage.
CfnStage.Builder	deploymentId(String deploymentId)	The deployment identifier for the API stage.
CfnStage.Builder	description(String description)	The description for the API stage.
CfnStage.Builder	routeSettings(Object routeSettings)	Route settings for the stage.
CfnStage.Builder	stageName(String stageName)	The stage name.
CfnStage.Builder	stageVariables(Object stageVariables)	A map that defines the stage variables for a Stage .
CfnStage.Builder	tags(Object tags)	The collection of tags.

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.

apiId

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

The API identifier.

Parameters:

apiId - The API identifier. This parameter is required.

Returns:

this

See Also:

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

stageName

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

The stage name.

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

Parameters:

stageName - The stage name. This parameter is required.

Returns:

this

See Also:

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

accessLogSettings

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

Settings for logging access in this stage.

Parameters:

accessLogSettings - Settings for logging access in this stage. This parameter is required.

Returns:

this

See Also:

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

accessLogSettings

@Stability(Stable)
public CfnStage.Builder accessLogSettings(CfnStage.AccessLogSettingsProperty accessLogSettings)

Settings for logging access in this stage.

Parameters:

accessLogSettings - Settings for logging access in this stage. This parameter is required.

Returns:

this

See Also:

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

accessPolicyId

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

This parameter is not currently supported.

Parameters:

accessPolicyId - This parameter is not currently supported. This parameter is required.

Returns:

this

See Also:

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

autoDeploy

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

Specifies whether updates to an API automatically trigger a new deployment.

The default value is false .

Parameters:

autoDeploy - Specifies whether updates to an API automatically trigger a new deployment. This parameter is required.

Returns:

this

See Also:

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

autoDeploy

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

Specifies whether updates to an API automatically trigger a new deployment.

The default value is false .

Parameters:

autoDeploy - Specifies whether updates to an API automatically trigger a new deployment. This parameter is required.

Returns:

this

See Also:

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

clientCertificateId

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

The identifier of a client certificate for a Stage .

Supported only for WebSocket APIs.

Parameters:

clientCertificateId - The identifier of a client certificate for a Stage . This parameter is required.

Returns:

this

See Also:

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

defaultRouteSettings

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

The default route settings for the stage.

Parameters:

defaultRouteSettings - The default route settings for the stage. This parameter is required.

Returns:

this

See Also:

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

defaultRouteSettings

@Stability(Stable)
public CfnStage.Builder defaultRouteSettings(CfnStage.RouteSettingsProperty defaultRouteSettings)

The default route settings for the stage.

Parameters:

defaultRouteSettings - The default route settings for the stage. This parameter is required.

Returns:

this

See Also:

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

deploymentId

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

The deployment identifier for the API stage.

Can't be updated if autoDeploy is enabled.

Parameters:

deploymentId - The deployment identifier for the API stage. This parameter is required.

Returns:

this

See Also:

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

description

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

The description for the API stage.

Parameters:

description - The description for the API stage. This parameter is required.

Returns:

this

See Also:

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

routeSettings

@Stability(Stable)
public CfnStage.Builder routeSettings(Object routeSettings)

Route settings for the stage.

Parameters:

routeSettings - Route settings for the stage. This parameter is required.

Returns:

this

See Also:

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

stageVariables

@Stability(Stable)
public CfnStage.Builder stageVariables(Object stageVariables)

A map that defines the stage variables for a Stage .

Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Parameters:

stageVariables - A map that defines the stage variables for a Stage . This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnStage.Builder tags(Object 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-apigatewayv2-stage.html#cfn-apigatewayv2-stage-tags

build

@Stability(Stable)
public CfnStage build()

Specified by:

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

Returns:

a newly built instance of CfnStage.