software.amazon.awscdk.services.codedeploy

Class CfnDeploymentGroup.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDeploymentGroup>

Enclosing class:

CfnDeploymentGroup

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

A fluent builder for CfnDeploymentGroup.

Method Summary

Modifier and Type	Method and Description
CfnDeploymentGroup.Builder	alarmConfiguration(CfnDeploymentGroup.AlarmConfigurationProperty alarmConfiguration) Information about the Amazon CloudWatch alarms that are associated with the deployment group.
CfnDeploymentGroup.Builder	alarmConfiguration(IResolvable alarmConfiguration) Information about the Amazon CloudWatch alarms that are associated with the deployment group.
CfnDeploymentGroup.Builder	applicationName(String applicationName) The name of an existing CodeDeploy application to associate this deployment group with.
CfnDeploymentGroup.Builder	autoRollbackConfiguration(CfnDeploymentGroup.AutoRollbackConfigurationProperty autoRollbackConfiguration) Information about the automatic rollback configuration that is associated with the deployment group.
CfnDeploymentGroup.Builder	autoRollbackConfiguration(IResolvable autoRollbackConfiguration) Information about the automatic rollback configuration that is associated with the deployment group.
CfnDeploymentGroup.Builder	autoScalingGroups(List<String> autoScalingGroups) A list of associated Auto Scaling groups that CodeDeploy automatically deploys revisions to when new instances are created.
CfnDeploymentGroup.Builder	blueGreenDeploymentConfiguration(CfnDeploymentGroup.BlueGreenDeploymentConfigurationProperty blueGreenDeploymentConfiguration) Information about blue/green deployment options for a deployment group.
CfnDeploymentGroup.Builder	blueGreenDeploymentConfiguration(IResolvable blueGreenDeploymentConfiguration) Information about blue/green deployment options for a deployment group.
CfnDeploymentGroup	build()
static CfnDeploymentGroup.Builder	create(software.constructs.Construct scope, String id)
CfnDeploymentGroup.Builder	deployment(CfnDeploymentGroup.DeploymentProperty deployment) The application revision to deploy to this deployment group.
CfnDeploymentGroup.Builder	deployment(IResolvable deployment) The application revision to deploy to this deployment group.
CfnDeploymentGroup.Builder	deploymentConfigName(String deploymentConfigName) A deployment configuration name or a predefined configuration name.
CfnDeploymentGroup.Builder	deploymentGroupName(String deploymentGroupName) A name for the deployment group.
CfnDeploymentGroup.Builder	deploymentStyle(CfnDeploymentGroup.DeploymentStyleProperty deploymentStyle) Attributes that determine the type of deployment to run and whether to route deployment traffic behind a load balancer.
CfnDeploymentGroup.Builder	deploymentStyle(IResolvable deploymentStyle) Attributes that determine the type of deployment to run and whether to route deployment traffic behind a load balancer.
CfnDeploymentGroup.Builder	ec2TagFilters(IResolvable ec2TagFilters) The Amazon EC2 tags that are already applied to Amazon EC2 instances that you want to include in the deployment group.
CfnDeploymentGroup.Builder	ec2TagFilters(List<? extends Object> ec2TagFilters) The Amazon EC2 tags that are already applied to Amazon EC2 instances that you want to include in the deployment group.
CfnDeploymentGroup.Builder	ec2TagSet(CfnDeploymentGroup.EC2TagSetProperty ec2TagSet) Information about groups of tags applied to Amazon EC2 instances.
CfnDeploymentGroup.Builder	ec2TagSet(IResolvable ec2TagSet) Information about groups of tags applied to Amazon EC2 instances.
CfnDeploymentGroup.Builder	ecsServices(IResolvable ecsServices) The target Amazon ECS services in the deployment group.
CfnDeploymentGroup.Builder	ecsServices(List<? extends Object> ecsServices) The target Amazon ECS services in the deployment group.
CfnDeploymentGroup.Builder	loadBalancerInfo(CfnDeploymentGroup.LoadBalancerInfoProperty loadBalancerInfo) Information about the load balancer to use in a deployment.
CfnDeploymentGroup.Builder	loadBalancerInfo(IResolvable loadBalancerInfo) Information about the load balancer to use in a deployment.
CfnDeploymentGroup.Builder	onPremisesInstanceTagFilters(IResolvable onPremisesInstanceTagFilters) The on-premises instance tags already applied to on-premises instances that you want to include in the deployment group.
CfnDeploymentGroup.Builder	onPremisesInstanceTagFilters(List<? extends Object> onPremisesInstanceTagFilters) The on-premises instance tags already applied to on-premises instances that you want to include in the deployment group.
CfnDeploymentGroup.Builder	onPremisesTagSet(CfnDeploymentGroup.OnPremisesTagSetProperty onPremisesTagSet) Information about groups of tags applied to on-premises instances.
CfnDeploymentGroup.Builder	onPremisesTagSet(IResolvable onPremisesTagSet) Information about groups of tags applied to on-premises instances.
CfnDeploymentGroup.Builder	outdatedInstancesStrategy(String outdatedInstancesStrategy) Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.
CfnDeploymentGroup.Builder	serviceRoleArn(String serviceRoleArn) A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf.
CfnDeploymentGroup.Builder	tags(List<? extends CfnTag> tags) The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them.
CfnDeploymentGroup.Builder	triggerConfigurations(IResolvable triggerConfigurations) Information about triggers associated with the deployment group.
CfnDeploymentGroup.Builder	triggerConfigurations(List<? extends Object> triggerConfigurations) Information about triggers associated with the deployment group.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static CfnDeploymentGroup.Builder create(software.constructs.Construct scope,
                                                                         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 CfnDeploymentGroup.AlarmConfigurationProperty.Builder.

applicationName

@Stability(value=Stable)
public CfnDeploymentGroup.Builder applicationName(String applicationName)

The name of an existing CodeDeploy application to associate this deployment group with.

Parameters:

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

Returns:

this

serviceRoleArn

@Stability(value=Stable)
public CfnDeploymentGroup.Builder serviceRoleArn(String serviceRoleArn)

A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf.

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 .

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.

Returns:

this

alarmConfiguration

@Stability(value=Stable)
public CfnDeploymentGroup.Builder alarmConfiguration(CfnDeploymentGroup.AlarmConfigurationProperty alarmConfiguration)

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

Parameters:

alarmConfiguration - Information about the Amazon CloudWatch alarms that are associated with the deployment group. This parameter is required.

Returns:

this

alarmConfiguration

@Stability(value=Stable)
public CfnDeploymentGroup.Builder alarmConfiguration(IResolvable alarmConfiguration)

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

Parameters:

alarmConfiguration - Information about the Amazon CloudWatch alarms that are associated with the deployment group. This parameter is required.

Returns:

this

autoRollbackConfiguration

@Stability(value=Stable)
public CfnDeploymentGroup.Builder autoRollbackConfiguration(CfnDeploymentGroup.AutoRollbackConfigurationProperty 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.

Parameters:

autoRollbackConfiguration - Information about the automatic rollback configuration that is associated with the deployment group. This parameter is required.

Returns:

this

autoRollbackConfiguration

@Stability(value=Stable)
public CfnDeploymentGroup.Builder autoRollbackConfiguration(IResolvable 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.

Parameters:

autoRollbackConfiguration - Information about the automatic rollback configuration that is associated with the deployment group. This parameter is required.

Returns:

this

autoScalingGroups

@Stability(value=Stable)
public CfnDeploymentGroup.Builder autoScalingGroups(List<String> autoScalingGroups)

A list of associated Auto Scaling groups that CodeDeploy automatically deploys revisions to when new instances are created.

Duplicates are not allowed.

Parameters:

autoScalingGroups - A list of associated Auto Scaling groups that CodeDeploy automatically deploys revisions to when new instances are created. This parameter is required.

Returns:

this

blueGreenDeploymentConfiguration

@Stability(value=Stable)
public CfnDeploymentGroup.Builder blueGreenDeploymentConfiguration(CfnDeploymentGroup.BlueGreenDeploymentConfigurationProperty blueGreenDeploymentConfiguration)

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

Parameters:

blueGreenDeploymentConfiguration - Information about blue/green deployment options for a deployment group. This parameter is required.

Returns:

this

blueGreenDeploymentConfiguration

@Stability(value=Stable)
public CfnDeploymentGroup.Builder blueGreenDeploymentConfiguration(IResolvable blueGreenDeploymentConfiguration)

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

Parameters:

blueGreenDeploymentConfiguration - Information about blue/green deployment options for a deployment group. This parameter is required.

Returns:

this

deployment

@Stability(value=Stable)
public CfnDeploymentGroup.Builder deployment(CfnDeploymentGroup.DeploymentProperty 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.

Parameters:

deployment - The application revision to deploy to this deployment group. This parameter is required.

Returns:

this

deployment

@Stability(value=Stable)
public CfnDeploymentGroup.Builder deployment(IResolvable 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.

Parameters:

deployment - The application revision to deploy to this deployment group. This parameter is required.

Returns:

this

deploymentConfigName

@Stability(value=Stable)
public CfnDeploymentGroup.Builder deploymentConfigName(String 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 .

Parameters:

deploymentConfigName - A deployment configuration name or a predefined configuration name. This parameter is required.

Returns:

this

deploymentGroupName

@Stability(value=Stable)
public CfnDeploymentGroup.Builder deploymentGroupName(String 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.

Parameters:

deploymentGroupName - A name for the deployment group. This parameter is required.

Returns:

this

deploymentStyle

@Stability(value=Stable)
public CfnDeploymentGroup.Builder deploymentStyle(CfnDeploymentGroup.DeploymentStyleProperty 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.

Parameters:

deploymentStyle - Attributes that determine the type of deployment to run and whether to route deployment traffic behind a load balancer. This parameter is required.

Returns:

this

deploymentStyle

@Stability(value=Stable)
public CfnDeploymentGroup.Builder deploymentStyle(IResolvable 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.

Parameters:

deploymentStyle - Attributes that determine the type of deployment to run and whether to route deployment traffic behind a load balancer. This parameter is required.

Returns:

this

ec2TagFilters

@Stability(value=Stable)
public CfnDeploymentGroup.Builder ec2TagFilters(IResolvable 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.

Parameters:

ec2TagFilters - The Amazon EC2 tags that are already applied to Amazon EC2 instances that you want to include in the deployment group. This parameter is required.

Returns:

this

ec2TagFilters

@Stability(value=Stable)
public CfnDeploymentGroup.Builder ec2TagFilters(List<? extends Object> 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.

Parameters:

ec2TagFilters - The Amazon EC2 tags that are already applied to Amazon EC2 instances that you want to include in the deployment group. This parameter is required.

Returns:

this

ec2TagSet

@Stability(value=Stable)
public CfnDeploymentGroup.Builder ec2TagSet(CfnDeploymentGroup.EC2TagSetProperty 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 .

Parameters:

ec2TagSet - Information about groups of tags applied to Amazon EC2 instances. This parameter is required.

Returns:

this

ec2TagSet

@Stability(value=Stable)
public CfnDeploymentGroup.Builder ec2TagSet(IResolvable 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 .

Parameters:

ec2TagSet - Information about groups of tags applied to Amazon EC2 instances. This parameter is required.

Returns:

this

ecsServices

@Stability(value=Stable)
public CfnDeploymentGroup.Builder ecsServices(IResolvable 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> .

Parameters:

ecsServices - The target Amazon ECS services in the deployment group. This parameter is required.

Returns:

this

ecsServices

@Stability(value=Stable)
public CfnDeploymentGroup.Builder ecsServices(List<? extends Object> 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> .

Parameters:

ecsServices - The target Amazon ECS services in the deployment group. This parameter is required.

Returns:

this

loadBalancerInfo

@Stability(value=Stable)
public CfnDeploymentGroup.Builder loadBalancerInfo(CfnDeploymentGroup.LoadBalancerInfoProperty 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 .

Parameters:

loadBalancerInfo - Information about the load balancer to use in a deployment. This parameter is required.

Returns:

this

loadBalancerInfo

@Stability(value=Stable)
public CfnDeploymentGroup.Builder loadBalancerInfo(IResolvable 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 .

Parameters:

loadBalancerInfo - Information about the load balancer to use in a deployment. This parameter is required.

Returns:

this

onPremisesInstanceTagFilters

@Stability(value=Stable)
public CfnDeploymentGroup.Builder onPremisesInstanceTagFilters(IResolvable 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.

Parameters:

onPremisesInstanceTagFilters - The on-premises instance tags already applied to on-premises instances that you want to include in the deployment group. This parameter is required.

Returns:

this

onPremisesInstanceTagFilters

@Stability(value=Stable)
public CfnDeploymentGroup.Builder onPremisesInstanceTagFilters(List<? extends Object> 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.

Parameters:

onPremisesInstanceTagFilters - The on-premises instance tags already applied to on-premises instances that you want to include in the deployment group. This parameter is required.

Returns:

this

onPremisesTagSet

@Stability(value=Stable)
public CfnDeploymentGroup.Builder onPremisesTagSet(CfnDeploymentGroup.OnPremisesTagSetProperty 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.

Parameters:

onPremisesTagSet - Information about groups of tags applied to on-premises instances. This parameter is required.

Returns:

this

onPremisesTagSet

@Stability(value=Stable)
public CfnDeploymentGroup.Builder onPremisesTagSet(IResolvable 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.

Parameters:

onPremisesTagSet - Information about groups of tags applied to on-premises instances. This parameter is required.

Returns:

this

outdatedInstancesStrategy

@Stability(value=Stable)
public CfnDeploymentGroup.Builder outdatedInstancesStrategy(String 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.

Parameters:

outdatedInstancesStrategy - Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnDeploymentGroup.Builder tags(List<? extends CfnTag> 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.

Parameters:

tags - The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. This parameter is required.

Returns:

this

triggerConfigurations

@Stability(value=Stable)
public CfnDeploymentGroup.Builder triggerConfigurations(IResolvable triggerConfigurations)

Information about triggers associated with the deployment group.

Duplicates are not allowed

Parameters:

triggerConfigurations - Information about triggers associated with the deployment group. This parameter is required.

Returns:

this

triggerConfigurations

@Stability(value=Stable)
public CfnDeploymentGroup.Builder triggerConfigurations(List<? extends Object> triggerConfigurations)

Information about triggers associated with the deployment group.

Duplicates are not allowed

Parameters:

triggerConfigurations - Information about triggers associated with the deployment group. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnDeploymentGroup build()

Specified by:

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