Skip to content

CreateDeploymentConfigInput

Source code in docs_src/capo_codedeploy/types/create_deployment_config_input.py
class CreateDeploymentConfigInput(TypedDict, closed=True):
    deployment_config_name: (
        "capo_codedeploy.types.deployment_config_name.DeploymentConfigName"
    )
    """<p>The name of the deployment configuration to create.</p>"""
    minimum_healthy_hosts: NotRequired[
        "capo_codedeploy.types.minimum_healthy_hosts.MinimumHealthyHosts"
    ]
    """<p>The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value.</p> <p>The type parameter takes either of the following values:</p> <ul> <li> <p>HOST_COUNT: The value parameter represents the minimum number of healthy instances as an absolute value.</p> </li> <li> <p>FLEET_PERCENT: The value parameter represents the minimum number of healthy instances as a percentage of the total number of instances in the deployment. If you specify FLEET_PERCENT, at the start of the deployment, CodeDeploy converts the percentage to the equivalent number of instances and rounds up fractional instances.</p> </li> </ul> <p>The value parameter takes an integer.</p> <p>For example, to set a minimum of 95% healthy instance, specify a type of FLEET_PERCENT and a value of 95.</p>"""
    traffic_routing_config: NotRequired[
        "capo_codedeploy.types.traffic_routing_config.TrafficRoutingConfig"
    ]
    """<p>The configuration that specifies how the deployment traffic is routed.</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>"""
    zonal_config: NotRequired["capo_codedeploy.types.zonal_config.ZonalConfig"]
    """<p>Configure the <code>ZonalConfig</code> object if you want CodeDeploy to deploy your application to one <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-availability-zones">Availability Zone</a> at a time, within an Amazon Web Services Region.</p> <p>For more information about the zonal configuration feature, see <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations-create.html#zonal-config">zonal configuration</a> in the <i>CodeDeploy User Guide</i>.</p>"""

compute_platform instance-attribute

compute_platform: NotRequired[ComputePlatform]

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

deployment_config_name instance-attribute

deployment_config_name: DeploymentConfigName

The name of the deployment configuration to create.

minimum_healthy_hosts instance-attribute

minimum_healthy_hosts: NotRequired[MinimumHealthyHosts]

The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value.

The type parameter takes either of the following values:

  • HOST_COUNT: The value parameter represents the minimum number of healthy instances as an absolute value.

  • FLEET_PERCENT: The value parameter represents the minimum number of healthy instances as a percentage of the total number of instances in the deployment. If you specify FLEET_PERCENT, at the start of the deployment, CodeDeploy converts the percentage to the equivalent number of instances and rounds up fractional instances.

The value parameter takes an integer.

For example, to set a minimum of 95% healthy instance, specify a type of FLEET_PERCENT and a value of 95.

traffic_routing_config instance-attribute

traffic_routing_config: NotRequired[TrafficRoutingConfig]

The configuration that specifies how the deployment traffic is routed.

zonal_config instance-attribute

zonal_config: NotRequired[ZonalConfig]

Configure the ZonalConfig object if you want CodeDeploy to deploy your application to one Availability Zone at a time, within an Amazon Web Services Region.

For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User Guide.