Package software.amazon.awscdk.services.codedeploy

Class CfnDeploymentGroupProps.Builder

java.lang.Object

software.amazon.awscdk.services.codedeploy.CfnDeploymentGroupProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDeploymentGroupProps>

Enclosing interface:

CfnDeploymentGroupProps

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

A builder for CfnDeploymentGroupProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDeploymentGroupProps.Builder	alarmConfiguration(IResolvable alarmConfiguration)	Sets the value of CfnDeploymentGroupProps.getAlarmConfiguration()
CfnDeploymentGroupProps.Builder	alarmConfiguration(CfnDeploymentGroup.AlarmConfigurationProperty alarmConfiguration)	Sets the value of CfnDeploymentGroupProps.getAlarmConfiguration()
CfnDeploymentGroupProps.Builder	applicationName(String applicationName)	Sets the value of CfnDeploymentGroupProps.getApplicationName()
CfnDeploymentGroupProps.Builder	autoRollbackConfiguration(IResolvable autoRollbackConfiguration)	Sets the value of CfnDeploymentGroupProps.getAutoRollbackConfiguration()
CfnDeploymentGroupProps.Builder	autoRollbackConfiguration(CfnDeploymentGroup.AutoRollbackConfigurationProperty autoRollbackConfiguration)	Sets the value of CfnDeploymentGroupProps.getAutoRollbackConfiguration()
CfnDeploymentGroupProps.Builder	autoScalingGroups(List<String> autoScalingGroups)	Sets the value of CfnDeploymentGroupProps.getAutoScalingGroups()
CfnDeploymentGroupProps.Builder	blueGreenDeploymentConfiguration(IResolvable blueGreenDeploymentConfiguration)	Sets the value of CfnDeploymentGroupProps.getBlueGreenDeploymentConfiguration()
CfnDeploymentGroupProps.Builder	blueGreenDeploymentConfiguration(CfnDeploymentGroup.BlueGreenDeploymentConfigurationProperty blueGreenDeploymentConfiguration)	Sets the value of CfnDeploymentGroupProps.getBlueGreenDeploymentConfiguration()
CfnDeploymentGroupProps	build()	Builds the configured instance.
CfnDeploymentGroupProps.Builder	deployment(IResolvable deployment)	Sets the value of CfnDeploymentGroupProps.getDeployment()
CfnDeploymentGroupProps.Builder	deployment(CfnDeploymentGroup.DeploymentProperty deployment)	Sets the value of CfnDeploymentGroupProps.getDeployment()
CfnDeploymentGroupProps.Builder	deploymentConfigName(String deploymentConfigName)	Sets the value of CfnDeploymentGroupProps.getDeploymentConfigName()
CfnDeploymentGroupProps.Builder	deploymentGroupName(String deploymentGroupName)	Sets the value of CfnDeploymentGroupProps.getDeploymentGroupName()
CfnDeploymentGroupProps.Builder	deploymentStyle(IResolvable deploymentStyle)	Sets the value of CfnDeploymentGroupProps.getDeploymentStyle()
CfnDeploymentGroupProps.Builder	deploymentStyle(CfnDeploymentGroup.DeploymentStyleProperty deploymentStyle)	Sets the value of CfnDeploymentGroupProps.getDeploymentStyle()
CfnDeploymentGroupProps.Builder	ec2TagFilters(List<? extends Object> ec2TagFilters)	Sets the value of CfnDeploymentGroupProps.getEc2TagFilters()
CfnDeploymentGroupProps.Builder	ec2TagFilters(IResolvable ec2TagFilters)	Sets the value of CfnDeploymentGroupProps.getEc2TagFilters()
CfnDeploymentGroupProps.Builder	ec2TagSet(IResolvable ec2TagSet)	Sets the value of CfnDeploymentGroupProps.getEc2TagSet()
CfnDeploymentGroupProps.Builder	ec2TagSet(CfnDeploymentGroup.EC2TagSetProperty ec2TagSet)	Sets the value of CfnDeploymentGroupProps.getEc2TagSet()
CfnDeploymentGroupProps.Builder	ecsServices(List<? extends Object> ecsServices)	Sets the value of CfnDeploymentGroupProps.getEcsServices()
CfnDeploymentGroupProps.Builder	ecsServices(IResolvable ecsServices)	Sets the value of CfnDeploymentGroupProps.getEcsServices()
CfnDeploymentGroupProps.Builder	loadBalancerInfo(IResolvable loadBalancerInfo)	Sets the value of CfnDeploymentGroupProps.getLoadBalancerInfo()
CfnDeploymentGroupProps.Builder	loadBalancerInfo(CfnDeploymentGroup.LoadBalancerInfoProperty loadBalancerInfo)	Sets the value of CfnDeploymentGroupProps.getLoadBalancerInfo()
CfnDeploymentGroupProps.Builder	onPremisesInstanceTagFilters(List<? extends Object> onPremisesInstanceTagFilters)	Sets the value of CfnDeploymentGroupProps.getOnPremisesInstanceTagFilters()
CfnDeploymentGroupProps.Builder	onPremisesInstanceTagFilters(IResolvable onPremisesInstanceTagFilters)	Sets the value of CfnDeploymentGroupProps.getOnPremisesInstanceTagFilters()
CfnDeploymentGroupProps.Builder	onPremisesTagSet(IResolvable onPremisesTagSet)	Sets the value of CfnDeploymentGroupProps.getOnPremisesTagSet()
CfnDeploymentGroupProps.Builder	onPremisesTagSet(CfnDeploymentGroup.OnPremisesTagSetProperty onPremisesTagSet)	Sets the value of CfnDeploymentGroupProps.getOnPremisesTagSet()
CfnDeploymentGroupProps.Builder	outdatedInstancesStrategy(String outdatedInstancesStrategy)	Sets the value of CfnDeploymentGroupProps.getOutdatedInstancesStrategy()
CfnDeploymentGroupProps.Builder	serviceRoleArn(String serviceRoleArn)	Sets the value of CfnDeploymentGroupProps.getServiceRoleArn()
CfnDeploymentGroupProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnDeploymentGroupProps.getTags()
CfnDeploymentGroupProps.Builder	terminationHookEnabled(Boolean terminationHookEnabled)	Sets the value of CfnDeploymentGroupProps.getTerminationHookEnabled()
CfnDeploymentGroupProps.Builder	terminationHookEnabled(IResolvable terminationHookEnabled)	Sets the value of CfnDeploymentGroupProps.getTerminationHookEnabled()
CfnDeploymentGroupProps.Builder	triggerConfigurations(List<? extends Object> triggerConfigurations)	Sets the value of CfnDeploymentGroupProps.getTriggerConfigurations()
CfnDeploymentGroupProps.Builder	triggerConfigurations(IResolvable triggerConfigurations)	Sets the value of CfnDeploymentGroupProps.getTriggerConfigurations()

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

applicationName

@Stability(Stable)
public CfnDeploymentGroupProps.Builder applicationName(String applicationName)

Sets the value of CfnDeploymentGroupProps.getApplicationName()

Parameters:

applicationName - The name of an existing CodeDeploy application to associate this deployment group with. This parameter is required.

Returns:

this

serviceRoleArn

@Stability(Stable)
public CfnDeploymentGroupProps.Builder serviceRoleArn(String serviceRoleArn)

Sets the value of CfnDeploymentGroupProps.getServiceRoleArn()

Parameters:

serviceRoleArn - A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf. This parameter is required. For more information, see Create a Service Role for AWS CodeDeploy in the AWS CodeDeploy User Guide .

In some cases, you might need to add a dependency on the service role's policy. For more information, see IAM role policy in DependsOn Attribute .

Returns:

this

alarmConfiguration

@Stability(Stable)
public CfnDeploymentGroupProps.Builder alarmConfiguration(IResolvable alarmConfiguration)

Sets the value of CfnDeploymentGroupProps.getAlarmConfiguration()

Parameters:

alarmConfiguration - Information about the Amazon CloudWatch alarms that are associated with the deployment group.

Returns:

this

alarmConfiguration

@Stability(Stable)
public CfnDeploymentGroupProps.Builder alarmConfiguration(CfnDeploymentGroup.AlarmConfigurationProperty alarmConfiguration)

Sets the value of CfnDeploymentGroupProps.getAlarmConfiguration()

Parameters:

alarmConfiguration - Information about the Amazon CloudWatch alarms that are associated with the deployment group.

Returns:

this

autoRollbackConfiguration

@Stability(Stable)
public CfnDeploymentGroupProps.Builder autoRollbackConfiguration(IResolvable autoRollbackConfiguration)

Sets the value of CfnDeploymentGroupProps.getAutoRollbackConfiguration()

Parameters:

autoRollbackConfiguration - Information about the automatic rollback configuration that is associated with the deployment group. If you specify this property, don't specify the Deployment property.

Returns:

this

autoRollbackConfiguration

@Stability(Stable)
public CfnDeploymentGroupProps.Builder autoRollbackConfiguration(CfnDeploymentGroup.AutoRollbackConfigurationProperty autoRollbackConfiguration)

Sets the value of CfnDeploymentGroupProps.getAutoRollbackConfiguration()

Parameters:

autoRollbackConfiguration - Information about the automatic rollback configuration that is associated with the deployment group. If you specify this property, don't specify the Deployment property.

Returns:

this

autoScalingGroups

@Stability(Stable)
public CfnDeploymentGroupProps.Builder autoScalingGroups(List<String> autoScalingGroups)

Sets the value of CfnDeploymentGroupProps.getAutoScalingGroups()

Parameters:

autoScalingGroups - A list of associated Auto Scaling groups that CodeDeploy automatically deploys revisions to when new instances are created. Duplicates are not allowed.

Returns:

this

blueGreenDeploymentConfiguration

@Stability(Stable)
public CfnDeploymentGroupProps.Builder blueGreenDeploymentConfiguration(IResolvable blueGreenDeploymentConfiguration)

Sets the value of CfnDeploymentGroupProps.getBlueGreenDeploymentConfiguration()

Parameters:

blueGreenDeploymentConfiguration - Information about blue/green deployment options for a deployment group.

Returns:

this

blueGreenDeploymentConfiguration

@Stability(Stable)
public CfnDeploymentGroupProps.Builder blueGreenDeploymentConfiguration(CfnDeploymentGroup.BlueGreenDeploymentConfigurationProperty blueGreenDeploymentConfiguration)

Sets the value of CfnDeploymentGroupProps.getBlueGreenDeploymentConfiguration()

Parameters:

blueGreenDeploymentConfiguration - Information about blue/green deployment options for a deployment group.

Returns:

this

deployment

@Stability(Stable)
public CfnDeploymentGroupProps.Builder deployment(IResolvable deployment)

Sets the value of CfnDeploymentGroupProps.getDeployment()

Parameters:

deployment - The application revision to deploy to this deployment group. If you specify this property, your target application revision is deployed as soon as the provisioning process is complete. If you specify this property, don't specify the AutoRollbackConfiguration property.

Returns:

this

deployment

@Stability(Stable)
public CfnDeploymentGroupProps.Builder deployment(CfnDeploymentGroup.DeploymentProperty deployment)

Sets the value of CfnDeploymentGroupProps.getDeployment()

Parameters:

deployment - The application revision to deploy to this deployment group. If you specify this property, your target application revision is deployed as soon as the provisioning process is complete. If you specify this property, don't specify the AutoRollbackConfiguration property.

Returns:

this

deploymentConfigName

@Stability(Stable)
public CfnDeploymentGroupProps.Builder deploymentConfigName(String deploymentConfigName)

Sets the value of CfnDeploymentGroupProps.getDeploymentConfigName()

Parameters:

deploymentConfigName - A deployment configuration name or a predefined configuration name. With predefined configurations, you can deploy application revisions to one instance at a time ( CodeDeployDefault.OneAtATime ), half of the instances at a time ( CodeDeployDefault.HalfAtATime ), or all the instances at once ( CodeDeployDefault.AllAtOnce ). For more information and valid values, see Working with Deployment Configurations in the AWS CodeDeploy User Guide .

Returns:

this

deploymentGroupName

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

Sets the value of CfnDeploymentGroupProps.getDeploymentGroupName()

Parameters:

deploymentGroupName - A name for the deployment group. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the deployment group name. For more information, see Name Type .

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

Returns:

this

deploymentStyle

@Stability(Stable)
public CfnDeploymentGroupProps.Builder deploymentStyle(IResolvable deploymentStyle)

Sets the value of CfnDeploymentGroupProps.getDeploymentStyle()

Parameters:

deploymentStyle - Attributes that determine the type of deployment to run and whether to route deployment traffic behind a load balancer. If you specify this property with a blue/green deployment type, don't specify the AutoScalingGroups , LoadBalancerInfo , or Deployment properties.

For blue/green deployments, AWS CloudFormation supports deployments on Lambda compute platforms only. You can perform Amazon ECS blue/green deployments using AWS::CodeDeploy::BlueGreen hook. See Perform Amazon ECS blue/green deployments through CodeDeploy using AWS CloudFormation for more information.

Returns:

this

deploymentStyle

@Stability(Stable)
public CfnDeploymentGroupProps.Builder deploymentStyle(CfnDeploymentGroup.DeploymentStyleProperty deploymentStyle)

Sets the value of CfnDeploymentGroupProps.getDeploymentStyle()

Parameters:

deploymentStyle - Attributes that determine the type of deployment to run and whether to route deployment traffic behind a load balancer. If you specify this property with a blue/green deployment type, don't specify the AutoScalingGroups , LoadBalancerInfo , or Deployment properties.

For blue/green deployments, AWS CloudFormation supports deployments on Lambda compute platforms only. You can perform Amazon ECS blue/green deployments using AWS::CodeDeploy::BlueGreen hook. See Perform Amazon ECS blue/green deployments through CodeDeploy using AWS CloudFormation for more information.

Returns:

this

ec2TagFilters

@Stability(Stable)
public CfnDeploymentGroupProps.Builder ec2TagFilters(IResolvable ec2TagFilters)

Sets the value of CfnDeploymentGroupProps.getEc2TagFilters()

Parameters:

ec2TagFilters - The Amazon EC2 tags that are already applied to Amazon EC2 instances that you want to include in the deployment group. CodeDeploy includes all Amazon EC2 instances identified by any of the tags you specify in this deployment group. Duplicates are not allowed.

You can specify EC2TagFilters or Ec2TagSet , but not both.

Returns:

this

ec2TagFilters

@Stability(Stable)
public CfnDeploymentGroupProps.Builder ec2TagFilters(List<? extends Object> ec2TagFilters)

Sets the value of CfnDeploymentGroupProps.getEc2TagFilters()

Parameters:

ec2TagFilters - The Amazon EC2 tags that are already applied to Amazon EC2 instances that you want to include in the deployment group. CodeDeploy includes all Amazon EC2 instances identified by any of the tags you specify in this deployment group. Duplicates are not allowed.

You can specify EC2TagFilters or Ec2TagSet , but not both.

Returns:

this

ec2TagSet

@Stability(Stable)
public CfnDeploymentGroupProps.Builder ec2TagSet(IResolvable ec2TagSet)

Sets the value of CfnDeploymentGroupProps.getEc2TagSet()

Parameters:

ec2TagSet - Information about groups of tags applied to Amazon EC2 instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilter .

Returns:

this

ec2TagSet

@Stability(Stable)
public CfnDeploymentGroupProps.Builder ec2TagSet(CfnDeploymentGroup.EC2TagSetProperty ec2TagSet)

Sets the value of CfnDeploymentGroupProps.getEc2TagSet()

Parameters:

ec2TagSet - Information about groups of tags applied to Amazon EC2 instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilter .

Returns:

this

ecsServices

@Stability(Stable)
public CfnDeploymentGroupProps.Builder ecsServices(IResolvable ecsServices)

Sets the value of CfnDeploymentGroupProps.getEcsServices()

Parameters:

ecsServices - The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <clustername>:<servicename> .

Returns:

this

ecsServices

@Stability(Stable)
public CfnDeploymentGroupProps.Builder ecsServices(List<? extends Object> ecsServices)

Sets the value of CfnDeploymentGroupProps.getEcsServices()

Parameters:

ecsServices - The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <clustername>:<servicename> .

Returns:

this

loadBalancerInfo

@Stability(Stable)
public CfnDeploymentGroupProps.Builder loadBalancerInfo(IResolvable loadBalancerInfo)

Sets the value of CfnDeploymentGroupProps.getLoadBalancerInfo()

Parameters:

loadBalancerInfo - Information about the load balancer to use in a deployment. For more information, see Integrating CodeDeploy with Elastic Load Balancing in the AWS CodeDeploy User Guide .

Returns:

this

loadBalancerInfo

@Stability(Stable)
public CfnDeploymentGroupProps.Builder loadBalancerInfo(CfnDeploymentGroup.LoadBalancerInfoProperty loadBalancerInfo)

Sets the value of CfnDeploymentGroupProps.getLoadBalancerInfo()

Parameters:

loadBalancerInfo - Information about the load balancer to use in a deployment. For more information, see Integrating CodeDeploy with Elastic Load Balancing in the AWS CodeDeploy User Guide .

Returns:

this

onPremisesInstanceTagFilters

@Stability(Stable)
public CfnDeploymentGroupProps.Builder onPremisesInstanceTagFilters(IResolvable onPremisesInstanceTagFilters)

Sets the value of CfnDeploymentGroupProps.getOnPremisesInstanceTagFilters()

Parameters:

onPremisesInstanceTagFilters - The on-premises instance tags already applied to on-premises instances that you want to include in the deployment group. CodeDeploy includes all on-premises instances identified by any of the tags you specify in this deployment group. To register on-premises instances with CodeDeploy , see Working with On-Premises Instances for CodeDeploy in the AWS CodeDeploy User Guide . Duplicates are not allowed.

You can specify OnPremisesInstanceTagFilters or OnPremisesInstanceTagSet , but not both.

Returns:

this

onPremisesInstanceTagFilters

@Stability(Stable)
public CfnDeploymentGroupProps.Builder onPremisesInstanceTagFilters(List<? extends Object> onPremisesInstanceTagFilters)

Sets the value of CfnDeploymentGroupProps.getOnPremisesInstanceTagFilters()

Parameters:

onPremisesInstanceTagFilters - The on-premises instance tags already applied to on-premises instances that you want to include in the deployment group. CodeDeploy includes all on-premises instances identified by any of the tags you specify in this deployment group. To register on-premises instances with CodeDeploy , see Working with On-Premises Instances for CodeDeploy in the AWS CodeDeploy User Guide . Duplicates are not allowed.

You can specify OnPremisesInstanceTagFilters or OnPremisesInstanceTagSet , but not both.

Returns:

this

onPremisesTagSet

@Stability(Stable)
public CfnDeploymentGroupProps.Builder onPremisesTagSet(IResolvable onPremisesTagSet)

Sets the value of CfnDeploymentGroupProps.getOnPremisesTagSet()

Parameters:

onPremisesTagSet - Information about groups of tags applied to on-premises instances. The deployment group includes only on-premises instances identified by all the tag groups.

You can specify OnPremisesInstanceTagFilters or OnPremisesInstanceTagSet , but not both.

Returns:

this

onPremisesTagSet

@Stability(Stable)
public CfnDeploymentGroupProps.Builder onPremisesTagSet(CfnDeploymentGroup.OnPremisesTagSetProperty onPremisesTagSet)

Sets the value of CfnDeploymentGroupProps.getOnPremisesTagSet()

Parameters:

onPremisesTagSet - Information about groups of tags applied to on-premises instances. The deployment group includes only on-premises instances identified by all the tag groups.

You can specify OnPremisesInstanceTagFilters or OnPremisesInstanceTagSet , but not both.

Returns:

this

outdatedInstancesStrategy

@Stability(Stable)
public CfnDeploymentGroupProps.Builder outdatedInstancesStrategy(String outdatedInstancesStrategy)

Sets the value of CfnDeploymentGroupProps.getOutdatedInstancesStrategy()

Parameters:

outdatedInstancesStrategy - Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision. If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new Amazon EC2 instances.

If this option is set to IGNORE , CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions.

Returns:

this

tags

@Stability(Stable)
public CfnDeploymentGroupProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnDeploymentGroupProps.getTags()

Parameters:

tags - The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.

Returns:

this

terminationHookEnabled

@Stability(Stable)
public CfnDeploymentGroupProps.Builder terminationHookEnabled(Boolean terminationHookEnabled)

Sets the value of CfnDeploymentGroupProps.getTerminationHookEnabled()

Parameters:

terminationHookEnabled - Indicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group. For more information about the termination hook, see How Amazon EC2 Auto Scaling works with CodeDeploy in the AWS CodeDeploy User Guide .

Returns:

this

terminationHookEnabled

@Stability(Stable)
public CfnDeploymentGroupProps.Builder terminationHookEnabled(IResolvable terminationHookEnabled)

Sets the value of CfnDeploymentGroupProps.getTerminationHookEnabled()

Parameters:

terminationHookEnabled - Indicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group. For more information about the termination hook, see How Amazon EC2 Auto Scaling works with CodeDeploy in the AWS CodeDeploy User Guide .

Returns:

this

triggerConfigurations

@Stability(Stable)
public CfnDeploymentGroupProps.Builder triggerConfigurations(IResolvable triggerConfigurations)

Sets the value of CfnDeploymentGroupProps.getTriggerConfigurations()

Parameters:

triggerConfigurations - Information about triggers associated with the deployment group. Duplicates are not allowed

Returns:

this

triggerConfigurations

@Stability(Stable)
public CfnDeploymentGroupProps.Builder triggerConfigurations(List<? extends Object> triggerConfigurations)

Sets the value of CfnDeploymentGroupProps.getTriggerConfigurations()

Parameters:

triggerConfigurations - Information about triggers associated with the deployment group. Duplicates are not allowed

Returns:

this

build

@Stability(Stable)
public CfnDeploymentGroupProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnDeploymentGroupProps

Throws:

NullPointerException - if any required attribute was not provided