Skip to content

DeploymentInfo

Source code in docs_src/capo_codedeploy/types/deployment_info.py
class DeploymentInfo(TypedDict, closed=True):
    application_name: NotRequired[
        "capo_codedeploy.types.application_name.ApplicationName"
    ]
    """<p>The application name.</p>"""
    deployment_group_name: NotRequired[
        "capo_codedeploy.types.deployment_group_name.DeploymentGroupName"
    ]
    """<p> The deployment group name. </p>"""
    deployment_config_name: NotRequired[
        "capo_codedeploy.types.deployment_config_name.DeploymentConfigName"
    ]
    """<p> The deployment configuration name. </p>"""
    deployment_id: NotRequired["capo_codedeploy.types.deployment_id.DeploymentId"]
    """<p> The unique ID of a deployment. </p>"""
    previous_revision: NotRequired[
        "capo_codedeploy.types.revision_location.RevisionLocation"
    ]
    """<p>Information about the application revision that was deployed to the deployment group before the most recent successful deployment.</p>"""
    revision: NotRequired["capo_codedeploy.types.revision_location.RevisionLocation"]
    """<p>Information about the location of stored application artifacts and the service from which to retrieve them.</p>"""
    status: NotRequired["capo_codedeploy.types.deployment_status.DeploymentStatus"]
    """<p>The current state of the deployment as a whole.</p>"""
    error_information: NotRequired[
        "capo_codedeploy.types.error_information.ErrorInformation"
    ]
    """<p>Information about any error associated with this deployment.</p>"""
    create_time: NotRequired["capo_codedeploy.types.timestamp.Timestamp"]
    """<p>A timestamp that indicates when the deployment was created.</p>"""
    start_time: NotRequired["capo_codedeploy.types.timestamp.Timestamp"]
    """<p>A timestamp that indicates when the deployment was deployed to the deployment group.</p> <p>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.</p>"""
    complete_time: NotRequired["capo_codedeploy.types.timestamp.Timestamp"]
    """<p>A timestamp that indicates when the deployment was complete.</p>"""
    deployment_overview: NotRequired[
        "capo_codedeploy.types.deployment_overview.DeploymentOverview"
    ]
    """<p>A summary of the deployment status of the instances in the deployment.</p>"""
    description: NotRequired["capo_codedeploy.types.description.Description"]
    """<p>A comment about the deployment.</p>"""
    creator: NotRequired["capo_codedeploy.types.deployment_creator.DeploymentCreator"]
    """<p>The means by which the deployment was created:</p> <ul> <li> <p> <code>user</code>: A user created the deployment.</p> </li> <li> <p> <code>autoscaling</code>: Amazon EC2 Auto Scaling created the deployment.</p> </li> <li> <p> <code>codeDeployRollback</code>: A rollback process created the deployment.</p> </li> <li> <p> <code>CodeDeployAutoUpdate</code>: An auto-update process created the deployment when it detected outdated Amazon EC2 instances.</p> </li> </ul>"""
    ignore_application_stop_failures: "capo_codedeploy.types.boolean.Boolean"
    """<p> If true, then if an <code>ApplicationStop</code>, <code>BeforeBlockTraffic</code>, or <code>AfterBlockTraffic</code> deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if <code>ApplicationStop</code> fails, the deployment continues with DownloadBundle. If <code>BeforeBlockTraffic</code> fails, the deployment continues with <code>BlockTraffic</code>. If <code>AfterBlockTraffic</code> fails, the deployment continues with <code>ApplicationStop</code>. </p> <p> 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. </p> <p> During a deployment, the CodeDeploy agent runs the scripts specified for <code>ApplicationStop</code>, <code>BeforeBlockTraffic</code>, and <code>AfterBlockTraffic</code> 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. </p> <p> 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 <code>ignoreApplicationStopFailures</code> to specify that the <code>ApplicationStop</code>, <code>BeforeBlockTraffic</code>, and <code>AfterBlockTraffic</code> failures should be ignored. </p>"""
    auto_rollback_configuration: NotRequired[
        "capo_codedeploy.types.auto_rollback_configuration.AutoRollbackConfiguration"
    ]
    """<p>Information about the automatic rollback configuration associated with the deployment.</p>"""
    update_outdated_instances_only: "capo_codedeploy.types.boolean.Boolean"
    """<p>Indicates whether only instances that are not running the latest application revision are to be deployed to.</p>"""
    rollback_info: NotRequired["capo_codedeploy.types.rollback_info.RollbackInfo"]
    """<p>Information about a deployment rollback.</p>"""
    deployment_style: NotRequired[
        "capo_codedeploy.types.deployment_style.DeploymentStyle"
    ]
    """<p>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.</p>"""
    target_instances: NotRequired[
        "capo_codedeploy.types.target_instances.TargetInstances"
    ]
    """<p>Information about the instances that belong to the replacement environment in a blue/green deployment.</p>"""
    instance_termination_wait_time_started: "capo_codedeploy.types.boolean.Boolean"
    """<p>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.</p>"""
    blue_green_deployment_configuration: NotRequired[
        "capo_codedeploy.types.blue_green_deployment_configuration.BlueGreenDeploymentConfiguration"
    ]
    """<p>Information about blue/green deployment options for this deployment.</p>"""
    load_balancer_info: NotRequired[
        "capo_codedeploy.types.load_balancer_info.LoadBalancerInfo"
    ]
    """<p>Information about the load balancer used in the deployment.</p>"""
    additional_deployment_status_info: NotRequired[
        "capo_codedeploy.types.additional_deployment_status_info.AdditionalDeploymentStatusInfo"
    ]
    """<p>Provides information about the results of a deployment, such as whether instances in the original environment in a blue/green deployment were not terminated.</p>"""
    file_exists_behavior: NotRequired[
        "capo_codedeploy.types.file_exists_behavior.FileExistsBehavior"
    ]
    """<p>Information about how CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.</p> <ul> <li> <p> <code>DISALLOW</code>: The deployment fails. This is also the default behavior if no option is specified.</p> </li> <li> <p> <code>OVERWRITE</code>: The version of the file from the application revision currently being deployed replaces the version already on the instance.</p> </li> <li> <p> <code>RETAIN</code>: The version of the file already on the instance is kept and used as part of the new deployment.</p> </li> </ul>"""
    deployment_mode: NotRequired["capo_codedeploy.types.deployment_mode.DeploymentMode"]
    """<p>The deployment's type. Valid values are:</p> <ul> <li> <p> <code>STANDARD</code>: The deployment installed the specified revision.</p> </li> <li> <p> <code>RESTART</code>: 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.</p> </li> </ul> <p>This field is absent for deployments created before <code>deploymentMode</code> existed, and for <code>STANDARD</code> deployments. An absent value must not be interpreted as <code>STANDARD</code>; it simply means no value was recorded either way.</p>"""
    deployment_status_messages: NotRequired[
        "capo_codedeploy.types.deployment_status_message_list.DeploymentStatusMessageList"
    ]
    """<p>Messages that contain information about the status of a deployment.</p>"""
    compute_platform: NotRequired[
        "capo_codedeploy.types.compute_platform.ComputePlatform"
    ]
    """<p>The destination platform type for the deployment (<code>Lambda</code>, <code>Server</code>, or <code>ECS</code>).</p>"""
    external_id: NotRequired["capo_codedeploy.types.external_id.ExternalId"]
    """<p>The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this deployment.</p>"""
    related_deployments: NotRequired[
        "capo_codedeploy.types.related_deployments.RelatedDeployments"
    ]
    override_alarm_configuration: NotRequired[
        "capo_codedeploy.types.alarm_configuration.AlarmConfiguration"
    ]

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.

related_deployments instance-attribute

related_deployments: NotRequired[RelatedDeployments]

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.

update_outdated_instances_only instance-attribute

update_outdated_instances_only: Boolean

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