AWS CodeDeploy
API Reference (API Version 2014-10-06)

DeploymentInfo

Information about a deployment.

Contents

additionalDeploymentStatusInfo

This member has been deprecated.

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

Type: String

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.

Type: AutoRollbackConfiguration object

Required: No

blueGreenDeploymentConfiguration

Information about blue/green deployment options for this deployment.

Type: BlueGreenDeploymentConfiguration object

Required: No

completeTime

A timestamp that indicates when the deployment was complete.

Type: Timestamp

Required: No

computePlatform

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

Type: String

Valid Values: Server | Lambda | ECS

Required: No

createTime

A timestamp that indicates when the deployment was created.

Type: Timestamp

Required: No

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.

Type: String

Valid Values: user | autoscaling | codeDeployRollback

Required: No

deploymentConfigName

The deployment configuration name.

Type: String

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

Required: No

deploymentGroupName

The deployment group name.

Type: String

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

Required: No

deploymentId

The unique ID of a deployment.

Type: String

Required: No

deploymentOverview

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

Type: DeploymentOverview object

Required: No

deploymentStatusMessages

Messages that contain information about the status of a deployment.

Type: Array of strings

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

description

A comment about the deployment.

Type: String

Required: No

errorInformation

Information about any error associated with this deployment.

Type: ErrorInformation object

Required: No

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.

Type: String

Valid Values: DISALLOW | OVERWRITE | RETAIN

Required: No

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.

Type: Boolean

Required: No

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.

Type: Boolean

Required: No

loadBalancerInfo

Information about the load balancer used in the deployment.

Type: LoadBalancerInfo object

Required: No

previousRevision

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

Type: RevisionLocation object

Required: No

revision

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

Type: RevisionLocation object

Required: No

rollbackInfo

Information about a deployment rollback.

Type: RollbackInfo object

Required: No

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.

Type: Timestamp

Required: No

status

The current state of the deployment as a whole.

Type: String

Valid Values: Created | Queued | InProgress | Succeeded | Failed | Stopped | Ready

Required: No

targetInstances

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

Type: TargetInstances object

Required: No

updateOutdatedInstancesOnly

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

Type: Boolean

Required: No

See Also

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

On this page: