CfnDeploymentConfigProps

class aws_cdk.aws_codedeploy.CfnDeploymentConfigProps(*, compute_platform=None, deployment_config_name=None, minimum_healthy_hosts=None, traffic_routing_config=None)

Bases: object

Properties for defining a CfnDeploymentConfig.

Parameters
  • compute_platform (Optional[str]) – The destination platform type for the deployment ( Lambda , Server , or ECS ).

  • deployment_config_name (Optional[str]) – A name for the deployment configuration. If you don’t specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the deployment configuration name. For more information, see Name Type . .. epigraph:: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

  • minimum_healthy_hosts (Union[MinimumHealthyHostsProperty, IResolvable, None]) – 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, AWS CodeDeploy converts the percentage to the equivalent number of instance 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. For more information about instance health, see CodeDeploy Instance Health in the AWS CodeDeploy User Guide.

  • traffic_routing_config (Union[IResolvable, TrafficRoutingConfigProperty, None]) – The configuration that specifies how the deployment traffic is routed.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_codedeploy as codedeploy

cfn_deployment_config_props = codedeploy.CfnDeploymentConfigProps(
    compute_platform="computePlatform",
    deployment_config_name="deploymentConfigName",
    minimum_healthy_hosts=codedeploy.CfnDeploymentConfig.MinimumHealthyHostsProperty(
        type="type",
        value=123
    ),
    traffic_routing_config=codedeploy.CfnDeploymentConfig.TrafficRoutingConfigProperty(
        type="type",

        # the properties below are optional
        time_based_canary=codedeploy.CfnDeploymentConfig.TimeBasedCanaryProperty(
            canary_interval=123,
            canary_percentage=123
        ),
        time_based_linear=codedeploy.CfnDeploymentConfig.TimeBasedLinearProperty(
            linear_interval=123,
            linear_percentage=123
        )
    )
)

Attributes

compute_platform

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html#cfn-codedeploy-deploymentconfig-computeplatform

Return type

Optional[str]

deployment_config_name

A name for the deployment configuration.

If you don’t specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the deployment configuration name. For more information, see Name Type . .. epigraph:

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html#cfn-codedeploy-deploymentconfig-deploymentconfigname

Return type

Optional[str]

minimum_healthy_hosts

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, AWS CodeDeploy converts the percentage to the equivalent number of instance 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.

For more information about instance health, see CodeDeploy Instance Health in the AWS CodeDeploy User Guide.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html#cfn-codedeploy-deploymentconfig-minimumhealthyhosts

Return type

Union[MinimumHealthyHostsProperty, IResolvable, None]

traffic_routing_config

The configuration that specifies how the deployment traffic is routed.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html#cfn-codedeploy-deploymentconfig-trafficroutingconfig

Return type

Union[IResolvable, TrafficRoutingConfigProperty, None]