Package software.amazon.awscdk.services.apigatewayv2

Class CfnStageProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.CfnStageProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnStageProps>

Enclosing interface:

CfnStageProps

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

A builder for CfnStageProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnStageProps.Builder	accessLogSettings(IResolvable accessLogSettings)	Sets the value of CfnStageProps.getAccessLogSettings()
CfnStageProps.Builder	accessLogSettings(CfnStage.AccessLogSettingsProperty accessLogSettings)	Sets the value of CfnStageProps.getAccessLogSettings()
CfnStageProps.Builder	accessPolicyId(String accessPolicyId)	Sets the value of CfnStageProps.getAccessPolicyId()
CfnStageProps.Builder	apiId(String apiId)	Sets the value of CfnStageProps.getApiId()
CfnStageProps.Builder	autoDeploy(Boolean autoDeploy)	Sets the value of CfnStageProps.getAutoDeploy()
CfnStageProps.Builder	autoDeploy(IResolvable autoDeploy)	Sets the value of CfnStageProps.getAutoDeploy()
CfnStageProps	build()	Builds the configured instance.
CfnStageProps.Builder	clientCertificateId(String clientCertificateId)	Sets the value of CfnStageProps.getClientCertificateId()
CfnStageProps.Builder	defaultRouteSettings(IResolvable defaultRouteSettings)	Sets the value of CfnStageProps.getDefaultRouteSettings()
CfnStageProps.Builder	defaultRouteSettings(CfnStage.RouteSettingsProperty defaultRouteSettings)	Sets the value of CfnStageProps.getDefaultRouteSettings()
CfnStageProps.Builder	deploymentId(String deploymentId)	Sets the value of CfnStageProps.getDeploymentId()
CfnStageProps.Builder	description(String description)	Sets the value of CfnStageProps.getDescription()
CfnStageProps.Builder	routeSettings(Object routeSettings)	Sets the value of CfnStageProps.getRouteSettings()
CfnStageProps.Builder	stageName(String stageName)	Sets the value of CfnStageProps.getStageName()
CfnStageProps.Builder	stageVariables(Object stageVariables)	Sets the value of CfnStageProps.getStageVariables()
CfnStageProps.Builder	tags(Object tags)	Sets the value of CfnStageProps.getTags()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

apiId

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

Sets the value of CfnStageProps.getApiId()

Parameters:

apiId - The API identifier. This parameter is required.

Returns:

this

stageName

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

Sets the value of CfnStageProps.getStageName()

Parameters:

stageName - The stage name. This parameter is required. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default . Maximum length is 128 characters.

Returns:

this

accessLogSettings

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

Sets the value of CfnStageProps.getAccessLogSettings()

Parameters:

accessLogSettings - Settings for logging access in this stage.

Returns:

this

accessLogSettings

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

Sets the value of CfnStageProps.getAccessLogSettings()

Parameters:

accessLogSettings - Settings for logging access in this stage.

Returns:

this

accessPolicyId

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

Sets the value of CfnStageProps.getAccessPolicyId()

Parameters:

accessPolicyId - This parameter is not currently supported.

Returns:

this

autoDeploy

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

Sets the value of CfnStageProps.getAutoDeploy()

Parameters:

autoDeploy - Specifies whether updates to an API automatically trigger a new deployment. The default value is false .

Returns:

this

autoDeploy

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

Sets the value of CfnStageProps.getAutoDeploy()

Parameters:

autoDeploy - Specifies whether updates to an API automatically trigger a new deployment. The default value is false .

Returns:

this

clientCertificateId

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

Sets the value of CfnStageProps.getClientCertificateId()

Parameters:

clientCertificateId - The identifier of a client certificate for a Stage . Supported only for WebSocket APIs.

Returns:

this

defaultRouteSettings

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

Sets the value of CfnStageProps.getDefaultRouteSettings()

Parameters:

defaultRouteSettings - The default route settings for the stage.

Returns:

this

defaultRouteSettings

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

Sets the value of CfnStageProps.getDefaultRouteSettings()

Parameters:

defaultRouteSettings - The default route settings for the stage.

Returns:

this

deploymentId

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

Sets the value of CfnStageProps.getDeploymentId()

Parameters:

deploymentId - The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.

Returns:

this

description

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

Sets the value of CfnStageProps.getDescription()

Parameters:

description - The description for the API stage.

Returns:

this

routeSettings

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

Sets the value of CfnStageProps.getRouteSettings()

Parameters:

routeSettings - Route settings for the stage.

Returns:

this

stageVariables

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

Sets the value of CfnStageProps.getStageVariables()

Parameters:

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-._~:/?#&=,]+.

Returns:

this

tags

@Stability(Stable)
public CfnStageProps.Builder tags(Object tags)

Sets the value of CfnStageProps.getTags()

Parameters:

tags - The collection of tags. Each tag element is associated with a given resource.

Returns:

this

build

@Stability(Stable)
public CfnStageProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnStageProps

Throws:

NullPointerException - if any required attribute was not provided