Package software.amazon.awscdk.services.codedeploy

Class EcsDeploymentGroupProps.Builder

java.lang.Object

software.amazon.awscdk.services.codedeploy.EcsDeploymentGroupProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<EcsDeploymentGroupProps>

Enclosing interface:

EcsDeploymentGroupProps

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

A builder for EcsDeploymentGroupProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
EcsDeploymentGroupProps.Builder	alarms(List<? extends IAlarm> alarms)	Sets the value of EcsDeploymentGroupProps.getAlarms()
EcsDeploymentGroupProps.Builder	application(IEcsApplication application)	Sets the value of EcsDeploymentGroupProps.getApplication()
EcsDeploymentGroupProps.Builder	autoRollback(AutoRollbackConfig autoRollback)	Sets the value of EcsDeploymentGroupProps.getAutoRollback()
EcsDeploymentGroupProps.Builder	blueGreenDeploymentConfig(EcsBlueGreenDeploymentConfig blueGreenDeploymentConfig)	Sets the value of EcsDeploymentGroupProps.getBlueGreenDeploymentConfig()
EcsDeploymentGroupProps	build()	Builds the configured instance.
EcsDeploymentGroupProps.Builder	deploymentConfig(IEcsDeploymentConfig deploymentConfig)	Sets the value of EcsDeploymentGroupProps.getDeploymentConfig()
EcsDeploymentGroupProps.Builder	deploymentGroupName(String deploymentGroupName)	Sets the value of EcsDeploymentGroupProps.getDeploymentGroupName()
EcsDeploymentGroupProps.Builder	ignoreAlarmConfiguration(Boolean ignoreAlarmConfiguration)	Sets the value of EcsDeploymentGroupProps.getIgnoreAlarmConfiguration()
EcsDeploymentGroupProps.Builder	ignorePollAlarmsFailure(Boolean ignorePollAlarmsFailure)	Sets the value of EcsDeploymentGroupProps.getIgnorePollAlarmsFailure()
EcsDeploymentGroupProps.Builder	role(IRole role)	Sets the value of EcsDeploymentGroupProps.getRole()
EcsDeploymentGroupProps.Builder	service(IBaseService service)	Sets the value of EcsDeploymentGroupProps.getService()

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

blueGreenDeploymentConfig

@Stability(Stable)
public EcsDeploymentGroupProps.Builder blueGreenDeploymentConfig(EcsBlueGreenDeploymentConfig blueGreenDeploymentConfig)

Sets the value of EcsDeploymentGroupProps.getBlueGreenDeploymentConfig()

Parameters:

blueGreenDeploymentConfig - The configuration options for blue-green ECS deployments. This parameter is required.

Returns:

this

service

@Stability(Stable)
public EcsDeploymentGroupProps.Builder service(IBaseService service)

Sets the value of EcsDeploymentGroupProps.getService()

Parameters:

service - The ECS service to deploy with this Deployment Group. This parameter is required.

Returns:

this

alarms

@Stability(Stable)
public EcsDeploymentGroupProps.Builder alarms(List<? extends IAlarm> alarms)

Sets the value of EcsDeploymentGroupProps.getAlarms()

Parameters:

alarms - The CloudWatch alarms associated with this Deployment Group. CodeDeploy will stop (and optionally roll back) a deployment if during it any of the alarms trigger.

Alarms can also be added after the Deployment Group is created using the #addAlarm method.

Returns:

this

application

@Stability(Stable)
public EcsDeploymentGroupProps.Builder application(IEcsApplication application)

Sets the value of EcsDeploymentGroupProps.getApplication()

Parameters:

application - The reference to the CodeDeploy ECS Application that this Deployment Group belongs to.

Returns:

this

autoRollback

@Stability(Stable)
public EcsDeploymentGroupProps.Builder autoRollback(AutoRollbackConfig autoRollback)

Sets the value of EcsDeploymentGroupProps.getAutoRollback()

Parameters:

autoRollback - The auto-rollback configuration for this Deployment Group.

Returns:

this

deploymentConfig

@Stability(Stable)
public EcsDeploymentGroupProps.Builder deploymentConfig(IEcsDeploymentConfig deploymentConfig)

Sets the value of EcsDeploymentGroupProps.getDeploymentConfig()

Parameters:

deploymentConfig - The Deployment Configuration this Deployment Group uses.

Returns:

this

deploymentGroupName

@Stability(Stable)
public EcsDeploymentGroupProps.Builder deploymentGroupName(String deploymentGroupName)

Sets the value of EcsDeploymentGroupProps.getDeploymentGroupName()

Parameters:

deploymentGroupName - The physical, human-readable name of the CodeDeploy Deployment Group.

Returns:

this

ignoreAlarmConfiguration

@Stability(Stable)
public EcsDeploymentGroupProps.Builder ignoreAlarmConfiguration(Boolean ignoreAlarmConfiguration)

Sets the value of EcsDeploymentGroupProps.getIgnoreAlarmConfiguration()

Parameters:

ignoreAlarmConfiguration - Whether to skip the step of checking CloudWatch alarms during the deployment process.

Returns:

this

ignorePollAlarmsFailure

@Stability(Stable)
public EcsDeploymentGroupProps.Builder ignorePollAlarmsFailure(Boolean ignorePollAlarmsFailure)

Sets the value of EcsDeploymentGroupProps.getIgnorePollAlarmsFailure()

Parameters:

ignorePollAlarmsFailure - Whether to continue a deployment even if fetching the alarm status from CloudWatch failed.

Returns:

this

role

@Stability(Stable)
public EcsDeploymentGroupProps.Builder role(IRole role)

Sets the value of EcsDeploymentGroupProps.getRole()

Parameters:

role - The service Role of this Deployment Group.

Returns:

this

build

@Stability(Stable)
public EcsDeploymentGroupProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of EcsDeploymentGroupProps

Throws:

NullPointerException - if any required attribute was not provided