public static final class CfnDeploymentGroupProps.Builder
extends java.lang.Object
CfnDeploymentGroupProps| Constructor and Description |
|---|
Builder() |
public CfnDeploymentGroupProps.Builder applicationName(java.lang.String applicationName)
CfnDeploymentGroupProps.getApplicationName()applicationName - The name of an existing CodeDeploy application to associate this deployment group with. This parameter is required.thispublic CfnDeploymentGroupProps.Builder serviceRoleArn(java.lang.String serviceRoleArn)
CfnDeploymentGroupProps.getServiceRoleArn()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 .
thispublic CfnDeploymentGroupProps.Builder alarmConfiguration(IResolvable alarmConfiguration)
CfnDeploymentGroupProps.getAlarmConfiguration()alarmConfiguration - Information about the Amazon CloudWatch alarms that are associated with the deployment group.thispublic CfnDeploymentGroupProps.Builder alarmConfiguration(CfnDeploymentGroup.AlarmConfigurationProperty alarmConfiguration)
CfnDeploymentGroupProps.getAlarmConfiguration()alarmConfiguration - Information about the Amazon CloudWatch alarms that are associated with the deployment group.thispublic CfnDeploymentGroupProps.Builder autoRollbackConfiguration(IResolvable autoRollbackConfiguration)
CfnDeploymentGroupProps.getAutoRollbackConfiguration()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.thispublic CfnDeploymentGroupProps.Builder autoRollbackConfiguration(CfnDeploymentGroup.AutoRollbackConfigurationProperty autoRollbackConfiguration)
CfnDeploymentGroupProps.getAutoRollbackConfiguration()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.thispublic CfnDeploymentGroupProps.Builder autoScalingGroups(java.util.List<java.lang.String> autoScalingGroups)
CfnDeploymentGroupProps.getAutoScalingGroups()autoScalingGroups - A list of associated Auto Scaling groups that CodeDeploy automatically deploys revisions to when new instances are created.
Duplicates are not allowed.thispublic CfnDeploymentGroupProps.Builder blueGreenDeploymentConfiguration(IResolvable blueGreenDeploymentConfiguration)
CfnDeploymentGroupProps.getBlueGreenDeploymentConfiguration()blueGreenDeploymentConfiguration - Information about blue/green deployment options for a deployment group.thispublic CfnDeploymentGroupProps.Builder blueGreenDeploymentConfiguration(CfnDeploymentGroup.BlueGreenDeploymentConfigurationProperty blueGreenDeploymentConfiguration)
CfnDeploymentGroupProps.getBlueGreenDeploymentConfiguration()blueGreenDeploymentConfiguration - Information about blue/green deployment options for a deployment group.thispublic CfnDeploymentGroupProps.Builder deployment(IResolvable deployment)
CfnDeploymentGroupProps.getDeployment()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.thispublic CfnDeploymentGroupProps.Builder deployment(CfnDeploymentGroup.DeploymentProperty deployment)
CfnDeploymentGroupProps.getDeployment()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.thispublic CfnDeploymentGroupProps.Builder deploymentConfigName(java.lang.String deploymentConfigName)
CfnDeploymentGroupProps.getDeploymentConfigName()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 .thispublic CfnDeploymentGroupProps.Builder deploymentGroupName(java.lang.String deploymentGroupName)
CfnDeploymentGroupProps.getDeploymentGroupName()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.
thispublic CfnDeploymentGroupProps.Builder deploymentStyle(IResolvable deploymentStyle)
CfnDeploymentGroupProps.getDeploymentStyle()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::BlueGreenhook. See Perform Amazon ECS blue/green deployments through CodeDeploy using AWS CloudFormation for more information.
thispublic CfnDeploymentGroupProps.Builder deploymentStyle(CfnDeploymentGroup.DeploymentStyleProperty deploymentStyle)
CfnDeploymentGroupProps.getDeploymentStyle()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::BlueGreenhook. See Perform Amazon ECS blue/green deployments through CodeDeploy using AWS CloudFormation for more information.
thispublic CfnDeploymentGroupProps.Builder ec2TagFilters(IResolvable ec2TagFilters)
CfnDeploymentGroupProps.getEc2TagFilters()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.
thispublic CfnDeploymentGroupProps.Builder ec2TagFilters(java.util.List<? extends java.lang.Object> ec2TagFilters)
CfnDeploymentGroupProps.getEc2TagFilters()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.
thispublic CfnDeploymentGroupProps.Builder ec2TagSet(IResolvable ec2TagSet)
CfnDeploymentGroupProps.getEc2TagSet()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 .thispublic CfnDeploymentGroupProps.Builder ec2TagSet(CfnDeploymentGroup.EC2TagSetProperty ec2TagSet)
CfnDeploymentGroupProps.getEc2TagSet()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 .thispublic CfnDeploymentGroupProps.Builder ecsServices(IResolvable ecsServices)
CfnDeploymentGroupProps.getEcsServices()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> .thispublic CfnDeploymentGroupProps.Builder ecsServices(java.util.List<? extends java.lang.Object> ecsServices)
CfnDeploymentGroupProps.getEcsServices()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> .thispublic CfnDeploymentGroupProps.Builder loadBalancerInfo(IResolvable loadBalancerInfo)
CfnDeploymentGroupProps.getLoadBalancerInfo()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 .thispublic CfnDeploymentGroupProps.Builder loadBalancerInfo(CfnDeploymentGroup.LoadBalancerInfoProperty loadBalancerInfo)
CfnDeploymentGroupProps.getLoadBalancerInfo()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 .thispublic CfnDeploymentGroupProps.Builder onPremisesInstanceTagFilters(IResolvable onPremisesInstanceTagFilters)
CfnDeploymentGroupProps.getOnPremisesInstanceTagFilters()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.
thispublic CfnDeploymentGroupProps.Builder onPremisesInstanceTagFilters(java.util.List<? extends java.lang.Object> onPremisesInstanceTagFilters)
CfnDeploymentGroupProps.getOnPremisesInstanceTagFilters()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.
thispublic CfnDeploymentGroupProps.Builder onPremisesTagSet(IResolvable onPremisesTagSet)
CfnDeploymentGroupProps.getOnPremisesTagSet()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.
thispublic CfnDeploymentGroupProps.Builder onPremisesTagSet(CfnDeploymentGroup.OnPremisesTagSetProperty onPremisesTagSet)
CfnDeploymentGroupProps.getOnPremisesTagSet()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.
thispublic CfnDeploymentGroupProps.Builder outdatedInstancesStrategy(java.lang.String outdatedInstancesStrategy)
CfnDeploymentGroupProps.getOutdatedInstancesStrategy()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.
thispublic CfnDeploymentGroupProps.Builder tags(java.util.List<? extends CfnTag> tags)
CfnDeploymentGroupProps.getTags()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.thispublic CfnDeploymentGroupProps.Builder triggerConfigurations(IResolvable triggerConfigurations)
CfnDeploymentGroupProps.getTriggerConfigurations()triggerConfigurations - Information about triggers associated with the deployment group.
Duplicates are not allowedthispublic CfnDeploymentGroupProps.Builder triggerConfigurations(java.util.List<? extends java.lang.Object> triggerConfigurations)
CfnDeploymentGroupProps.getTriggerConfigurations()triggerConfigurations - Information about triggers associated with the deployment group.
Duplicates are not allowedthispublic CfnDeploymentGroupProps build()
CfnDeploymentGroupPropsjava.lang.NullPointerException - if any required attribute was not provided