DeploymentInfo
¶
Source code in docs_src/capo_codedeploy/types/deployment_info.py
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 | |
additional_deployment_status_info
instance-attribute
¶
additional_deployment_status_info: NotRequired[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.
application_name
instance-attribute
¶
application_name: NotRequired[ApplicationName]
The application name.
auto_rollback_configuration
instance-attribute
¶
auto_rollback_configuration: NotRequired[AutoRollbackConfiguration]
Information about the automatic rollback configuration associated with the deployment.
blue_green_deployment_configuration
instance-attribute
¶
blue_green_deployment_configuration: NotRequired[BlueGreenDeploymentConfiguration]
Information about blue/green deployment options for this deployment.
complete_time
instance-attribute
¶
complete_time: NotRequired[Timestamp]
A timestamp that indicates when the deployment was complete.
compute_platform
instance-attribute
¶
compute_platform: NotRequired[ComputePlatform]
The destination platform type for the deployment (Lambda, Server, or ECS).
create_time
instance-attribute
¶
create_time: NotRequired[Timestamp]
A timestamp that indicates when the deployment was created.
creator
instance-attribute
¶
creator: NotRequired[DeploymentCreator]
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 Amazon EC2 instances.
deployment_config_name
instance-attribute
¶
deployment_config_name: NotRequired[DeploymentConfigName]
The deployment configuration name.
deployment_group_name
instance-attribute
¶
deployment_group_name: NotRequired[DeploymentGroupName]
The deployment group name.
deployment_id
instance-attribute
¶
deployment_id: NotRequired[DeploymentId]
The unique ID of a deployment.
deployment_mode
instance-attribute
¶
deployment_mode: NotRequired[DeploymentMode]
The deployment's type. Valid values are:
-
STANDARD: The deployment installed the specified revision. -
RESTART: The deployment restarted the application on the target instances using the revision from the deployment group's last successful deployment, without downloading a new revision.
This field is absent for deployments created before deploymentMode existed, and for STANDARD deployments. An absent value must not be interpreted as STANDARD; it simply means no value was recorded either way.
deployment_overview
instance-attribute
¶
deployment_overview: NotRequired[DeploymentOverview]
A summary of the deployment status of the instances in the deployment.
deployment_status_messages
instance-attribute
¶
deployment_status_messages: NotRequired[DeploymentStatusMessageList]
Messages that contain information about the status of a deployment.
deployment_style
instance-attribute
¶
deployment_style: NotRequired[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.
description
instance-attribute
¶
description: NotRequired[Description]
A comment about the deployment.
error_information
instance-attribute
¶
error_information: NotRequired[ErrorInformation]
Information about any error associated with this deployment.
external_id
instance-attribute
¶
external_id: NotRequired[ExternalId]
The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this deployment.
file_exists_behavior
instance-attribute
¶
file_exists_behavior: NotRequired[FileExistsBehavior]
Information about how 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.
ignore_application_stop_failures
instance-attribute
¶
ignore_application_stop_failures: 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. 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 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.
instance_termination_wait_time_started
instance-attribute
¶
instance_termination_wait_time_started: Boolean
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.
load_balancer_info
instance-attribute
¶
load_balancer_info: NotRequired[LoadBalancerInfo]
Information about the load balancer used in the deployment.
override_alarm_configuration
instance-attribute
¶
override_alarm_configuration: NotRequired[AlarmConfiguration]
previous_revision
instance-attribute
¶
previous_revision: NotRequired[RevisionLocation]
Information about the application revision that was deployed to the deployment group before the most recent successful deployment.
revision
instance-attribute
¶
revision: NotRequired[RevisionLocation]
Information about the location of stored application artifacts and the service from which to retrieve them.
rollback_info
instance-attribute
¶
rollback_info: NotRequired[RollbackInfo]
Information about a deployment rollback.
start_time
instance-attribute
¶
start_time: NotRequired[Timestamp]
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.
status
instance-attribute
¶
status: NotRequired[DeploymentStatus]
The current state of the deployment as a whole.
target_instances
instance-attribute
¶
target_instances: NotRequired[TargetInstances]
Information about the instances that belong to the replacement environment in a blue/green deployment.