Skip to content

Deployment

Source code in docs_src/capo_appconfig/types/deployment.py
class Deployment(TypedDict, closed=True):
    application_id: NotRequired["capo_appconfig.types.id.Id"]
    """<p>The ID of the application that was deployed.</p>"""
    environment_id: NotRequired["capo_appconfig.types.id.Id"]
    """<p>The ID of the environment that was deployed.</p>"""
    deployment_strategy_id: NotRequired["capo_appconfig.types.id.Id"]
    """<p>The ID of the deployment strategy that was deployed.</p>"""
    configuration_profile_id: NotRequired["capo_appconfig.types.id.Id"]
    """<p>The ID of the configuration profile that was deployed.</p>"""
    deployment_number: "capo_appconfig.types.integer.Integer"
    """<p>The sequence number of the deployment.</p>"""
    configuration_name: NotRequired["capo_appconfig.types.name.Name"]
    """<p>The name of the configuration.</p>"""
    configuration_location_uri: NotRequired["capo_appconfig.types.uri.Uri"]
    """<p>Information about the source location of the configuration.</p>"""
    configuration_version: NotRequired["capo_appconfig.types.version.Version"]
    """<p>The configuration version that was deployed.</p>"""
    description: NotRequired["capo_appconfig.types.description.Description"]
    """<p>The description of the deployment.</p>"""
    deployment_duration_in_minutes: (
        "capo_appconfig.types.minutes_between0_and24_hours.MinutesBetween0And24Hours"
    )
    """<p>Total amount of time the deployment lasted.</p>"""
    growth_type: NotRequired["capo_appconfig.types.growth_type.GrowthType"]
    """<p>The algorithm used to define how percentage grew over time.</p>"""
    growth_factor: NotRequired["capo_appconfig.types.percentage.Percentage"]
    """<p>The percentage of targets to receive a deployed configuration during each interval.</p>"""
    final_bake_time_in_minutes: (
        "capo_appconfig.types.minutes_between0_and24_hours.MinutesBetween0And24Hours"
    )
    """<p>The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.</p>"""
    state: NotRequired["capo_appconfig.types.deployment_state.DeploymentState"]
    """<p>The state of the deployment.</p>"""
    event_log: NotRequired["capo_appconfig.types.deployment_events.DeploymentEvents"]
    """<p>A list containing all events related to a deployment. The most recent events are displayed first.</p>"""
    percentage_complete: NotRequired["capo_appconfig.types.percentage.Percentage"]
    """<p>The percentage of targets for which the deployment is available.</p>"""
    started_at: NotRequired["capo_appconfig.types.iso8601_date_time.Iso8601DateTime"]
    """<p>The time the deployment started.</p>"""
    completed_at: NotRequired["capo_appconfig.types.iso8601_date_time.Iso8601DateTime"]
    """<p>The time the deployment completed. </p>"""
    applied_extensions: NotRequired[
        "capo_appconfig.types.applied_extensions.AppliedExtensions"
    ]
    """<p>A list of extensions that were processed as part of the deployment. The extensions that were previously associated to the configuration profile, environment, or the application when <code>StartDeployment</code> was called.</p>"""
    kms_key_arn: NotRequired["capo_appconfig.types.arn.Arn"]
    """<p>The Amazon Resource Name of the Key Management Service key used to encrypt configuration data. You can encrypt secrets stored in Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in Amazon Web Services Systems Manager Parameter Store. </p>"""
    kms_key_identifier: NotRequired[
        "capo_appconfig.types.kms_key_identifier.KmsKeyIdentifier"
    ]
    """<p>The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.</p>"""
    version_label: NotRequired["capo_appconfig.types.version_label.VersionLabel"]
    """<p>A user-defined label for an AppConfig hosted configuration version.</p>"""

application_id instance-attribute

application_id: NotRequired[Id]

The ID of the application that was deployed.

applied_extensions instance-attribute

applied_extensions: NotRequired[AppliedExtensions]

A list of extensions that were processed as part of the deployment. The extensions that were previously associated to the configuration profile, environment, or the application when StartDeployment was called.

completed_at instance-attribute

completed_at: NotRequired[Iso8601DateTime]

The time the deployment completed.

configuration_location_uri instance-attribute

configuration_location_uri: NotRequired[Uri]

Information about the source location of the configuration.

configuration_name instance-attribute

configuration_name: NotRequired[Name]

The name of the configuration.

configuration_profile_id instance-attribute

configuration_profile_id: NotRequired[Id]

The ID of the configuration profile that was deployed.

configuration_version instance-attribute

configuration_version: NotRequired[Version]

The configuration version that was deployed.

deployment_duration_in_minutes instance-attribute

deployment_duration_in_minutes: MinutesBetween0And24Hours

Total amount of time the deployment lasted.

deployment_number instance-attribute

deployment_number: Integer

The sequence number of the deployment.

deployment_strategy_id instance-attribute

deployment_strategy_id: NotRequired[Id]

The ID of the deployment strategy that was deployed.

description instance-attribute

description: NotRequired[Description]

The description of the deployment.

environment_id instance-attribute

environment_id: NotRequired[Id]

The ID of the environment that was deployed.

event_log instance-attribute

event_log: NotRequired[DeploymentEvents]

A list containing all events related to a deployment. The most recent events are displayed first.

final_bake_time_in_minutes instance-attribute

final_bake_time_in_minutes: MinutesBetween0And24Hours

The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

growth_factor instance-attribute

growth_factor: NotRequired[Percentage]

The percentage of targets to receive a deployed configuration during each interval.

growth_type instance-attribute

growth_type: NotRequired[GrowthType]

The algorithm used to define how percentage grew over time.

kms_key_arn instance-attribute

kms_key_arn: NotRequired[Arn]

The Amazon Resource Name of the Key Management Service key used to encrypt configuration data. You can encrypt secrets stored in Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in Amazon Web Services Systems Manager Parameter Store.

kms_key_identifier instance-attribute

kms_key_identifier: NotRequired[KmsKeyIdentifier]

The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.

percentage_complete instance-attribute

percentage_complete: NotRequired[Percentage]

The percentage of targets for which the deployment is available.

started_at instance-attribute

started_at: NotRequired[Iso8601DateTime]

The time the deployment started.

state instance-attribute

state: NotRequired[DeploymentState]

The state of the deployment.

version_label instance-attribute

version_label: NotRequired[VersionLabel]

A user-defined label for an AppConfig hosted configuration version.