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(value=Stable)
public static final class CfnDeploymentProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDeploymentProps>

A builder for CfnDeploymentProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnDeploymentProps	build() Builds the configured instance.
CfnDeploymentProps.Builder	deploymentCanarySettings(CfnDeployment.DeploymentCanarySettingsProperty deploymentCanarySettings) Sets the value of CfnDeploymentProps.getDeploymentCanarySettings()
CfnDeploymentProps.Builder	deploymentCanarySettings(IResolvable 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(CfnDeployment.StageDescriptionProperty stageDescription) Sets the value of CfnDeploymentProps.getStageDescription()
CfnDeploymentProps.Builder	stageDescription(IResolvable 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 Detail

Builder

public Builder()

Method Detail

restApiId

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

Sets the value of CfnDeploymentProps.getRestApiId()

Parameters:

restApiId - The ID of the `RestApi` resource to deploy. This parameter is required.

Returns:

this

deploymentCanarySettings

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

Sets the value of CfnDeploymentProps.getDeploymentCanarySettings()

Parameters:

deploymentCanarySettings - Specifies settings for the canary deployment.

Returns:

this

deploymentCanarySettings

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

Sets the value of CfnDeploymentProps.getDeploymentCanarySettings()

Parameters:

deploymentCanarySettings - Specifies settings for the canary deployment.

Returns:

this

description

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

Sets the value of CfnDeploymentProps.getDescription()

Parameters:

description - A description of the purpose of the API Gateway deployment.

Returns:

this

stageDescription

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

Sets the value of CfnDeploymentProps.getStageDescription()

Parameters:

stageDescription - Configures the stage that API Gateway creates with this deployment.

Returns:

this

stageDescription

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

Sets the value of CfnDeploymentProps.getStageDescription()

Parameters:

stageDescription - Configures the stage that API Gateway creates with this deployment.

Returns:

this

stageName

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

Sets the value of CfnDeploymentProps.getStageName()

Parameters:

stageName - A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters.

Returns:

this

build

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