software.amazon.awscdk.services.codedeploy

Class CfnDeploymentGroup.DeploymentProperty.Builder

java.lang.Object

software.amazon.awscdk.services.codedeploy.CfnDeploymentGroup.DeploymentProperty.Builder

Enclosing interface:

CfnDeploymentGroup.DeploymentProperty

public static final class CfnDeploymentGroup.DeploymentProperty.Builder
extends java.lang.Object

A builder for CfnDeploymentGroup.DeploymentProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnDeploymentGroup.DeploymentProperty	build() Builds the configured instance.
CfnDeploymentGroup.DeploymentProperty.Builder	description(java.lang.String description) Sets the value of CfnDeploymentGroup.DeploymentProperty.getDescription()
CfnDeploymentGroup.DeploymentProperty.Builder	ignoreApplicationStopFailures(java.lang.Boolean ignoreApplicationStopFailures) Sets the value of CfnDeploymentGroup.DeploymentProperty.getIgnoreApplicationStopFailures()
CfnDeploymentGroup.DeploymentProperty.Builder	ignoreApplicationStopFailures(IResolvable ignoreApplicationStopFailures) Sets the value of CfnDeploymentGroup.DeploymentProperty.getIgnoreApplicationStopFailures()
CfnDeploymentGroup.DeploymentProperty.Builder	revision(CfnDeploymentGroup.RevisionLocationProperty revision) Sets the value of CfnDeploymentGroup.DeploymentProperty.getRevision()
CfnDeploymentGroup.DeploymentProperty.Builder	revision(IResolvable revision) Sets the value of CfnDeploymentGroup.DeploymentProperty.getRevision()

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

revision

public CfnDeploymentGroup.DeploymentProperty.Builder revision(IResolvable revision)

Sets the value of CfnDeploymentGroup.DeploymentProperty.getRevision()

Parameters:

revision - Information about the location of stored application artifacts and the service from which to retrieve them. This parameter is required.

Returns:

this

revision

public CfnDeploymentGroup.DeploymentProperty.Builder revision(CfnDeploymentGroup.RevisionLocationProperty revision)

Sets the value of CfnDeploymentGroup.DeploymentProperty.getRevision()

Parameters:

revision - Information about the location of stored application artifacts and the service from which to retrieve them. This parameter is required.

Returns:

this

description

public CfnDeploymentGroup.DeploymentProperty.Builder description(java.lang.String description)

Sets the value of CfnDeploymentGroup.DeploymentProperty.getDescription()

Parameters:

description - A comment about the deployment.

Returns:

this

ignoreApplicationStopFailures

public CfnDeploymentGroup.DeploymentProperty.Builder ignoreApplicationStopFailures(java.lang.Boolean ignoreApplicationStopFailures)

Sets the value of CfnDeploymentGroup.DeploymentProperty.getIgnoreApplicationStopFailures()

Parameters:

ignoreApplicationStopFailures - If true, then if an `ApplicationStop` , `BeforeBlockTraffic` , or `AfterBlockTraffic` deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic . If AfterBlockTraffic fails, the deployment continues with ApplicationStop .

If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.

During a deployment, the AWS CodeDeploy agent runs the scripts specified for ApplicationStop , BeforeBlockTraffic , and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.

If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop , BeforeBlockTraffic , and AfterBlockTraffic failures should be ignored.

Returns:

this

ignoreApplicationStopFailures

public CfnDeploymentGroup.DeploymentProperty.Builder ignoreApplicationStopFailures(IResolvable ignoreApplicationStopFailures)

Sets the value of CfnDeploymentGroup.DeploymentProperty.getIgnoreApplicationStopFailures()

Parameters:

ignoreApplicationStopFailures - If true, then if an `ApplicationStop` , `BeforeBlockTraffic` , or `AfterBlockTraffic` deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic . If AfterBlockTraffic fails, the deployment continues with ApplicationStop .

If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.

During a deployment, the AWS CodeDeploy agent runs the scripts specified for ApplicationStop , BeforeBlockTraffic , and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.

If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop , BeforeBlockTraffic , and AfterBlockTraffic failures should be ignored.

Returns:

this

build

public CfnDeploymentGroup.DeploymentProperty build()

Builds the configured instance.

Returns:

a new instance of CfnDeploymentGroup.DeploymentProperty

Throws:

java.lang.NullPointerException - if any required attribute was not provided