software.amazon.awscdk.services.apigateway

Class CfnDeployment.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnDeployment.Builder

Enclosing class:

CfnDeployment

public static final class CfnDeployment.Builder
extends java.lang.Object

A fluent builder for CfnDeployment.

Method Summary

Modifier and Type	Method and Description
CfnDeployment	build()
static CfnDeployment.Builder	create(Construct scope, java.lang.String id)
CfnDeployment.Builder	deploymentCanarySettings(CfnDeployment.DeploymentCanarySettingsProperty deploymentCanarySettings) Specifies settings for the canary deployment.
CfnDeployment.Builder	deploymentCanarySettings(IResolvable deploymentCanarySettings) Specifies settings for the canary deployment.
CfnDeployment.Builder	description(java.lang.String description) A description of the purpose of the API Gateway deployment.
CfnDeployment.Builder	restApiId(java.lang.String restApiId) The ID of the `RestApi` resource to deploy.
CfnDeployment.Builder	stageDescription(CfnDeployment.StageDescriptionProperty stageDescription) Configures the stage that API Gateway creates with this deployment.
CfnDeployment.Builder	stageDescription(IResolvable stageDescription) Configures the stage that API Gateway creates with this deployment.
CfnDeployment.Builder	stageName(java.lang.String stageName) A name for the stage that API Gateway creates with this deployment.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static CfnDeployment.Builder create(Construct scope,
                                           java.lang.String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnDeployment.AccessLogSettingProperty.Builder.

restApiId

public CfnDeployment.Builder restApiId(java.lang.String restApiId)

The ID of the `RestApi` resource to deploy.

Parameters:

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

Returns:

this

deploymentCanarySettings

public CfnDeployment.Builder deploymentCanarySettings(IResolvable deploymentCanarySettings)

Specifies settings for the canary deployment.

Parameters:

deploymentCanarySettings - Specifies settings for the canary deployment. This parameter is required.

Returns:

this

deploymentCanarySettings

public CfnDeployment.Builder deploymentCanarySettings(CfnDeployment.DeploymentCanarySettingsProperty deploymentCanarySettings)

Specifies settings for the canary deployment.

Parameters:

deploymentCanarySettings - Specifies settings for the canary deployment. This parameter is required.

Returns:

this

description

public CfnDeployment.Builder description(java.lang.String description)

A description of the purpose of the API Gateway deployment.

Parameters:

description - A description of the purpose of the API Gateway deployment. This parameter is required.

Returns:

this

stageDescription

public CfnDeployment.Builder stageDescription(IResolvable stageDescription)

Configures the stage that API Gateway creates with this deployment.

Parameters:

stageDescription - Configures the stage that API Gateway creates with this deployment. This parameter is required.

Returns:

this

stageDescription

public CfnDeployment.Builder stageDescription(CfnDeployment.StageDescriptionProperty stageDescription)

Configures the stage that API Gateway creates with this deployment.

Parameters:

stageDescription - Configures the stage that API Gateway creates with this deployment. This parameter is required.

Returns:

this

stageName

public CfnDeployment.Builder stageName(java.lang.String stageName)

A name for the stage that API Gateway creates with this deployment.

Use only alphanumeric characters.

Parameters:

stageName - A name for the stage that API Gateway creates with this deployment. This parameter is required.

Returns:

this

build

public CfnDeployment build()