Package software.amazon.awscdk.services.apigateway

Class CfnDeploymentProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnDeploymentProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDeploymentProps>

Enclosing interface:

CfnDeploymentProps

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

A builder for CfnDeploymentProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDeploymentProps	build()	Builds the configured instance.
CfnDeploymentProps.Builder	deploymentCanarySettings(IResolvable deploymentCanarySettings)	Sets the value of CfnDeploymentProps.getDeploymentCanarySettings()
CfnDeploymentProps.Builder	deploymentCanarySettings(CfnDeployment.DeploymentCanarySettingsProperty deploymentCanarySettings)	Sets the value of CfnDeploymentProps.getDeploymentCanarySettings()
CfnDeploymentProps.Builder	description(String description)	Sets the value of CfnDeploymentProps.getDescription()
CfnDeploymentProps.Builder	restApiId(String restApiId)	Sets the value of CfnDeploymentProps.getRestApiId()
CfnDeploymentProps.Builder	stageDescription(IResolvable stageDescription)	Sets the value of CfnDeploymentProps.getStageDescription()
CfnDeploymentProps.Builder	stageDescription(CfnDeployment.StageDescriptionProperty stageDescription)	Sets the value of CfnDeploymentProps.getStageDescription()
CfnDeploymentProps.Builder	stageName(String stageName)	Sets the value of CfnDeploymentProps.getStageName()

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

restApiId

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

Sets the value of CfnDeploymentProps.getRestApiId()

Parameters:

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

Returns:

this

deploymentCanarySettings

@Stability(Stable)
public CfnDeploymentProps.Builder deploymentCanarySettings(IResolvable deploymentCanarySettings)

Sets the value of CfnDeploymentProps.getDeploymentCanarySettings()

Parameters:

deploymentCanarySettings - The input configuration for a canary deployment.

Returns:

this

deploymentCanarySettings

@Stability(Stable)
public CfnDeploymentProps.Builder deploymentCanarySettings(CfnDeployment.DeploymentCanarySettingsProperty deploymentCanarySettings)

Sets the value of CfnDeploymentProps.getDeploymentCanarySettings()

Parameters:

deploymentCanarySettings - The input configuration for a canary deployment.

Returns:

this

description

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

Sets the value of CfnDeploymentProps.getDescription()

Parameters:

description - The description for the Deployment resource to create.

Returns:

this

stageDescription

@Stability(Stable)
public CfnDeploymentProps.Builder stageDescription(IResolvable stageDescription)

Sets the value of CfnDeploymentProps.getStageDescription()

Parameters:

stageDescription - The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.

Returns:

this

stageDescription

@Stability(Stable)
public CfnDeploymentProps.Builder stageDescription(CfnDeployment.StageDescriptionProperty stageDescription)

Sets the value of CfnDeploymentProps.getStageDescription()

Parameters:

stageDescription - The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.

Returns:

this

stageName

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

Sets the value of CfnDeploymentProps.getStageName()

Parameters:

stageName - The name of the Stage resource for the Deployment resource to create.

Returns:

this

build

@Stability(Stable)
public CfnDeploymentProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnDeploymentProps

Throws:

NullPointerException - if any required attribute was not provided