DeploymentGroupInfo - AWS CodeDeploy

DeploymentGroupInfo

Information about a deployment group.

Contents

alarmConfiguration

A list of alarms associated with the deployment group.

Type: AlarmConfiguration object

Required: No

applicationName

The application name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

autoRollbackConfiguration

Information about the automatic rollback configuration associated with the deployment group.

Type: AutoRollbackConfiguration object

Required: No

autoScalingGroups

A list of associated Auto Scaling groups.

Type: Array of AutoScalingGroup objects

Required: No

blueGreenDeploymentConfiguration

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

Type: BlueGreenDeploymentConfiguration object

Required: No

computePlatform

The destination platform type for the deployment (Lambda, Server, or ECS).

Type: String

Valid Values: Server | Lambda | ECS

Required: No

deploymentConfigName

The deployment configuration name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

deploymentGroupId

The deployment group ID.

Type: String

Required: No

deploymentGroupName

The deployment group name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

deploymentStyle

Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.

Type: DeploymentStyle object

Required: No

ec2TagFilters

The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags.

Type: Array of EC2TagFilter objects

Required: No

ec2TagSet

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

Type: EC2TagSet object

Required: No

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>.

Type: Array of ECSService objects

Required: No

lastAttemptedDeployment

Information about the most recent attempted deployment to the deployment group.

Type: LastDeploymentInfo object

Required: No

lastSuccessfulDeployment

Information about the most recent successful deployment to the deployment group.

Type: LastDeploymentInfo object

Required: No

loadBalancerInfo

Information about the load balancer to use in a deployment.

Type: LoadBalancerInfo object

Required: No

onPremisesInstanceTagFilters

The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags.

Type: Array of TagFilter objects

Required: No

onPremisesTagSet

Information about groups of tags applied to an on-premises instance. The deployment group includes only on-premises instances identified by all the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.

Type: OnPremisesTagSet object

Required: No

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.

Type: String

Valid Values: UPDATE | IGNORE

Required: No

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.

Type: String

Required: No

targetRevision

Information about the deployment group's target revision, including type and location.

Type: RevisionLocation object

Required: No

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.

Type: Boolean

Required: No

triggerConfigurations

Information about triggers associated with the deployment group.

Type: Array of TriggerConfig objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: