Documentation

Information about a deployment.

See: newDeploymentInfo smart constructor.

Create a value of DeploymentInfo 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:creator:DeploymentInfo', deploymentInfo_creator - The means by which the deployment was created:

• user: A user created the deployment.
• autoscaling: Amazon EC2 Auto Scaling created the deployment.
• codeDeployRollback: A rollback process created the deployment.
• CodeDeployAutoUpdate: An auto-update process created the deployment when it detected outdated EC2 instances.

$sel:status:DeploymentInfo', deploymentInfo_status - The current state of the deployment as a whole.

$sel:deploymentId:DeploymentInfo', deploymentInfo_deploymentId - The unique ID of a deployment.

$sel:deploymentConfigName:DeploymentInfo', deploymentInfo_deploymentConfigName - The deployment configuration name.

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

$sel:previousRevision:DeploymentInfo', deploymentInfo_previousRevision - Information about the application revision that was deployed to the deployment group before the most recent successful deployment.

$sel:instanceTerminationWaitTimeStarted:DeploymentInfo', deploymentInfo_instanceTerminationWaitTimeStarted - Indicates whether the wait period set for the termination of instances in the original environment has started. Status is 'false' if the KEEP_ALIVE option is specified. Otherwise, 'true' as soon as the termination wait period starts.

$sel:deploymentStatusMessages:DeploymentInfo', deploymentInfo_deploymentStatusMessages - Messages that contain information about the status of a deployment.

$sel:relatedDeployments:DeploymentInfo', deploymentInfo_relatedDeployments - Undocumented member.

$sel:startTime:DeploymentInfo', deploymentInfo_startTime - A timestamp that indicates when the deployment was deployed to the deployment group.

In some cases, the reported value of the start time might be later than the complete time. This is due to differences in the clock settings of backend servers that participate in the deployment process.

$sel:completeTime:DeploymentInfo', deploymentInfo_completeTime - A timestamp that indicates when the deployment was complete.

$sel:blueGreenDeploymentConfiguration:DeploymentInfo', deploymentInfo_blueGreenDeploymentConfiguration - Information about blue/green deployment options for this deployment.

$sel:errorInformation:DeploymentInfo', deploymentInfo_errorInformation - Information about any error associated with this deployment.

$sel:loadBalancerInfo:DeploymentInfo', deploymentInfo_loadBalancerInfo - Information about the load balancer used in the deployment.

$sel:additionalDeploymentStatusInfo:DeploymentInfo', deploymentInfo_additionalDeploymentStatusInfo - Provides information about the results of a deployment, such as whether instances in the original environment in a blue/green deployment were not terminated.

$sel:deploymentOverview:DeploymentInfo', deploymentInfo_deploymentOverview - A summary of the deployment status of the instances in the deployment.

$sel:fileExistsBehavior:DeploymentInfo', deploymentInfo_fileExistsBehavior - Information about how AWS CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.

• DISALLOW: The deployment fails. This is also the default behavior if no option is specified.
• OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.
• RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.

$sel:applicationName:DeploymentInfo', deploymentInfo_applicationName - The application name.

$sel:rollbackInfo:DeploymentInfo', deploymentInfo_rollbackInfo - Information about a deployment rollback.

$sel:externalId:DeploymentInfo', deploymentInfo_externalId - The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this deployment.

$sel:targetInstances:DeploymentInfo', deploymentInfo_targetInstances - Information about the instances that belong to the replacement environment in a blue/green deployment.

$sel:revision:DeploymentInfo', deploymentInfo_revision - Information about the location of stored application artifacts and the service from which to retrieve them.

$sel:description:DeploymentInfo', deploymentInfo_description - A comment about the deployment.

$sel:deploymentStyle:DeploymentInfo', deploymentInfo_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:createTime:DeploymentInfo', deploymentInfo_createTime - A timestamp that indicates when the deployment was created.

$sel:autoRollbackConfiguration:DeploymentInfo', deploymentInfo_autoRollbackConfiguration - Information about the automatic rollback configuration associated with the deployment.

$sel:updateOutdatedInstancesOnly:DeploymentInfo', deploymentInfo_updateOutdatedInstancesOnly - Indicates whether only instances that are not running the latest application revision are to be deployed to.

$sel:deploymentGroupName:DeploymentInfo', deploymentInfo_deploymentGroupName - The deployment group name.

$sel:ignoreApplicationStopFailures:DeploymentInfo', deploymentInfo_ignoreApplicationStopFailures - If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop.

If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.

During a deployment, the AWS CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.

If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored.

The means by which the deployment was created:

• user: A user created the deployment.
• autoscaling: Amazon EC2 Auto Scaling created the deployment.
• codeDeployRollback: A rollback process created the deployment.
• CodeDeployAutoUpdate: An auto-update process created the deployment when it detected outdated EC2 instances.

The current state of the deployment as a whole.

The unique ID of a deployment.

The deployment configuration name.

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

Information about the application revision that was deployed to the deployment group before the most recent successful deployment.

Indicates whether the wait period set for the termination of instances in the original environment has started. Status is 'false' if the KEEP_ALIVE option is specified. Otherwise, 'true' as soon as the termination wait period starts.

Messages that contain information about the status of a deployment.

Undocumented member.

A timestamp that indicates when the deployment was deployed to the deployment group.

In some cases, the reported value of the start time might be later than the complete time. This is due to differences in the clock settings of backend servers that participate in the deployment process.

A timestamp that indicates when the deployment was complete.

Information about blue/green deployment options for this deployment.

Information about any error associated with this deployment.

Information about the load balancer used in the deployment.

Provides information about the results of a deployment, such as whether instances in the original environment in a blue/green deployment were not terminated.

A summary of the deployment status of the instances in the deployment.

Information about how AWS CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.

• DISALLOW: The deployment fails. This is also the default behavior if no option is specified.
• OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.
• RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.

The application name.

Information about a deployment rollback.

The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this deployment.

Information about the instances that belong to the replacement environment in a blue/green deployment.

Information about the location of stored application artifacts and the service from which to retrieve them.

A comment about the deployment.

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.

A timestamp that indicates when the deployment was created.

Information about the automatic rollback configuration associated with the deployment.

Indicates whether only instances that are not running the latest application revision are to be deployed to.

The deployment group name.

If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop.

If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.

During a deployment, the AWS CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.

If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored.