You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CodeDeploy::Types::DeploymentInfo

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Information about a deployment.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#additional_deployment_status_infoString

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

Returns:

  • (String)

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

#application_nameString

The application name.

Returns:

  • (String)

    The application name.

#auto_rollback_configurationTypes::AutoRollbackConfiguration

Information about the automatic rollback configuration associated with the deployment.

Returns:

#blue_green_deployment_configurationTypes::BlueGreenDeploymentConfiguration

Information about blue/green deployment options for this deployment.

Returns:

#complete_timeTime

A timestamp that indicates when the deployment was complete.

Returns:

  • (Time)

    A timestamp that indicates when the deployment was complete.

#compute_platformString

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

Possible values:

  • Server
  • Lambda
  • ECS

Returns:

  • (String)

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

#create_timeTime

A timestamp that indicates when the deployment was created.

Returns:

  • (Time)

    A timestamp that indicates when the deployment was created.

#creatorString

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.

    Possible values:

    • user
    • autoscaling
    • codeDeployRollback

Returns:

  • (String)

    The means by which the deployment was created:.

#deployment_config_nameString

The deployment configuration name.

Returns:

  • (String)

    The deployment configuration name.

#deployment_group_nameString

The deployment group name.

Returns:

  • (String)

    The deployment group name.

#deployment_idString

The unique ID of a deployment.

Returns:

  • (String)

    The unique ID of a deployment.

#deployment_overviewTypes::DeploymentOverview

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

Returns:

#deployment_status_messagesArray<String>

Messages that contain information about the status of a deployment.

Returns:

  • (Array<String>)

    Messages that contain information about the status of a deployment.

#deployment_styleTypes::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.

Returns:

  • (Types::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.

#descriptionString

A comment about the deployment.

Returns:

  • (String)

    A comment about the deployment.

#error_informationTypes::ErrorInformation

Information about any error associated with this deployment.

Returns:

#file_exists_behaviorString

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.

    Possible values:

    • DISALLOW
    • OVERWRITE
    • RETAIN

Returns:

  • (String)

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

#ignore_application_stop_failuresBoolean

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.

Returns:

  • (Boolean)

    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.

#instance_termination_wait_time_startedBoolean

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.

Returns:

  • (Boolean)

    Indicates whether the wait period set for the termination of instances in the original environment has started.

#load_balancer_infoTypes::LoadBalancerInfo

Information about the load balancer used in the deployment.

Returns:

#previous_revisionTypes::RevisionLocation

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

Returns:

  • (Types::RevisionLocation)

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

#revisionTypes::RevisionLocation

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

Returns:

  • (Types::RevisionLocation)

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

#rollback_infoTypes::RollbackInfo

Information about a deployment rollback.

Returns:

#start_timeTime

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.

Returns:

  • (Time)

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

#statusString

The current state of the deployment as a whole.

Possible values:

  • Created
  • Queued
  • InProgress
  • Succeeded
  • Failed
  • Stopped
  • Ready

Returns:

  • (String)

    The current state of the deployment as a whole.

#target_instancesTypes::TargetInstances

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

Returns:

  • (Types::TargetInstances)

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

#update_outdated_instances_onlyBoolean

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

Returns:

  • (Boolean)

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