Documentation

Information about a deployment group.

See: newDeploymentGroupInfo smart constructor.

Create a value of DeploymentGroupInfo with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:serviceRoleArn:DeploymentGroupInfo', deploymentGroupInfo_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.

$sel:ec2TagSet:DeploymentGroupInfo', deploymentGroupInfo_ec2TagSet - Information about groups of tags applied to an EC2 instance. The deployment group includes only EC2 instances identified by all of the tag groups. Cannot be used in the same call as ec2TagFilters.

$sel:deploymentConfigName:DeploymentGroupInfo', deploymentGroupInfo_deploymentConfigName - The deployment configuration name.

$sel:lastAttemptedDeployment:DeploymentGroupInfo', deploymentGroupInfo_lastAttemptedDeployment - Information about the most recent attempted deployment to the deployment group.

$sel:onPremisesTagSet:DeploymentGroupInfo', deploymentGroupInfo_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.

$sel:computePlatform:DeploymentGroupInfo', deploymentGroupInfo_computePlatform - The destination platform type for the deployment (Lambda, Server, or ECS).

$sel:targetRevision:DeploymentGroupInfo', deploymentGroupInfo_targetRevision - Information about the deployment group's target revision, including type and location.

$sel:ec2TagFilters:DeploymentGroupInfo', deploymentGroupInfo_ec2TagFilters - The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags.

$sel:ecsServices:DeploymentGroupInfo', deploymentGroupInfo_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>.

$sel:blueGreenDeploymentConfiguration:DeploymentGroupInfo', deploymentGroupInfo_blueGreenDeploymentConfiguration - Information about blue/green deployment options for a deployment group.

$sel:loadBalancerInfo:DeploymentGroupInfo', deploymentGroupInfo_loadBalancerInfo - Information about the load balancer to use in a deployment.

$sel:outdatedInstancesStrategy:DeploymentGroupInfo', deploymentGroupInfo_outdatedInstancesStrategy - Indicates what happens when new 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 EC2 instances.

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

$sel:onPremisesInstanceTagFilters:DeploymentGroupInfo', deploymentGroupInfo_onPremisesInstanceTagFilters - The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags.

$sel:lastSuccessfulDeployment:DeploymentGroupInfo', deploymentGroupInfo_lastSuccessfulDeployment - Information about the most recent successful deployment to the deployment group.

$sel:applicationName:DeploymentGroupInfo', deploymentGroupInfo_applicationName - The application name.

$sel:alarmConfiguration:DeploymentGroupInfo', deploymentGroupInfo_alarmConfiguration - A list of alarms associated with the deployment group.

$sel:triggerConfigurations:DeploymentGroupInfo', deploymentGroupInfo_triggerConfigurations - Information about triggers associated with the deployment group.

$sel:deploymentGroupId:DeploymentGroupInfo', deploymentGroupInfo_deploymentGroupId - The deployment group ID.

$sel:autoScalingGroups:DeploymentGroupInfo', deploymentGroupInfo_autoScalingGroups - A list of associated Auto Scaling groups.

$sel:deploymentStyle:DeploymentGroupInfo', deploymentGroupInfo_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.

$sel:autoRollbackConfiguration:DeploymentGroupInfo', deploymentGroupInfo_autoRollbackConfiguration - Information about the automatic rollback configuration associated with the deployment group.

$sel:deploymentGroupName:DeploymentGroupInfo', deploymentGroupInfo_deploymentGroupName - The deployment group name.

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.

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

The deployment configuration name.

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

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.

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

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

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

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

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

Information about the load balancer to use in a deployment.

Indicates what happens when new 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 EC2 instances.

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

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

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

The application name.

A list of alarms associated with the deployment group.

Information about triggers associated with the deployment group.

The deployment group ID.

A list of associated Auto Scaling groups.

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.

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

The deployment group name.