Skip to content

StartDeploymentRequest

Source code in docs_src/capo_appconfig/types/start_deployment_request.py
class StartDeploymentRequest(TypedDict, closed=True):
    application_id: "capo_appconfig.types.name.Name"
    """<p>The application ID.</p>"""
    environment_id: "capo_appconfig.types.name.Name"
    """<p>The environment ID.</p>"""
    deployment_strategy_id: (
        "capo_appconfig.types.deployment_strategy_id.DeploymentStrategyId"
    )
    """<p>The deployment strategy ID.</p>"""
    configuration_profile_id: "capo_appconfig.types.long_name.LongName"
    """<p>The configuration profile ID.</p>"""
    configuration_version: "capo_appconfig.types.version.Version"
    """<p>The configuration version to deploy. If deploying an AppConfig hosted configuration version, you can specify either the version number or version label. For all other configurations, you must specify the version number.</p>"""
    description: NotRequired["capo_appconfig.types.description.Description"]
    """<p>A description of the deployment.</p>"""
    tags: NotRequired["capo_appconfig.types.tag_map.TagMap"]
    """<p>Metadata to assign to the deployment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.</p>"""
    kms_key_identifier: NotRequired[
        "capo_appconfig.types.kms_key_identifier.KmsKeyIdentifier"
    ]
    """<p>The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key. </p>"""
    dynamic_extension_parameters: NotRequired[
        "capo_appconfig.types.dynamic_parameter_map.DynamicParameterMap"
    ]
    """<p>A map of dynamic extension parameter names to values to pass to associated extensions with <code>PRE_START_DEPLOYMENT</code> actions.</p>"""
    latest_deployment_number: NotRequired["capo_appconfig.types.integer.Integer"]
    """<p>The number of the latest deployment. Use this value to ensure that the deployment starts from the expected state and to prevent conflicting updates.</p>"""

application_id instance-attribute

application_id: Name

The application ID.

configuration_profile_id instance-attribute

configuration_profile_id: LongName

The configuration profile ID.

configuration_version instance-attribute

configuration_version: Version

The configuration version to deploy. If deploying an AppConfig hosted configuration version, you can specify either the version number or version label. For all other configurations, you must specify the version number.

deployment_strategy_id instance-attribute

deployment_strategy_id: DeploymentStrategyId

The deployment strategy ID.

description instance-attribute

description: NotRequired[Description]

A description of the deployment.

dynamic_extension_parameters instance-attribute

dynamic_extension_parameters: NotRequired[DynamicParameterMap]

A map of dynamic extension parameter names to values to pass to associated extensions with PRE_START_DEPLOYMENT actions.

environment_id instance-attribute

environment_id: Name

The environment ID.

kms_key_identifier instance-attribute

kms_key_identifier: NotRequired[KmsKeyIdentifier]

The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.

latest_deployment_number instance-attribute

latest_deployment_number: NotRequired[Integer]

The number of the latest deployment. Use this value to ensure that the deployment starts from the expected state and to prevent conflicting updates.

tags instance-attribute

tags: NotRequired[TagMap]

Metadata to assign to the deployment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.