Interface ICfnDeploymentConfigProps

Properties for defining a CfnDeploymentConfig.

Namespace: Amazon.CDK.AWS.CodeDeploy

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnDeploymentConfigProps

Syntax (vb)

Public Interface ICfnDeploymentConfigProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CodeDeploy;

             var cfnDeploymentConfigProps = new CfnDeploymentConfigProps {
                 ComputePlatform = "computePlatform",
                 DeploymentConfigName = "deploymentConfigName",
                 MinimumHealthyHosts = new MinimumHealthyHostsProperty {
                     Type = "type",
                     Value = 123
                 },
                 TrafficRoutingConfig = new TrafficRoutingConfigProperty {
                     Type = "type",

                     // the properties below are optional
                     TimeBasedCanary = new TimeBasedCanaryProperty {
                         CanaryInterval = 123,
                         CanaryPercentage = 123
                     },
                     TimeBasedLinear = new TimeBasedLinearProperty {
                         LinearInterval = 123,
                         LinearPercentage = 123
                     }
                 },
                 ZonalConfig = new ZonalConfigProperty {
                     FirstZoneMonitorDurationInSeconds = 123,
                     MinimumHealthyHostsPerZone = new MinimumHealthyHostsPerZoneProperty {
                         Type = "type",
                         Value = 123
                     },
                     MonitorDurationInSeconds = 123
                 }
             };

Synopsis

Properties

ComputePlatform	The destination platform type for the deployment ( Lambda , Server , or ECS ).
DeploymentConfigName	A name for the deployment configuration.
MinimumHealthyHosts	The minimum number of healthy instances that should be available at any time during the deployment.
TrafficRoutingConfig	The configuration that specifies how the deployment traffic is routed.
ZonalConfig	Configure the ZonalConfig object if you want AWS CodeDeploy to deploy your application to one Availability Zone at a time, within an AWS Region.

Properties

ComputePlatform

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

string? ComputePlatform { get; }

Property Value

string

Remarks

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

DeploymentConfigName

A name for the deployment configuration.

string? DeploymentConfigName { get; }

Property Value

string

Remarks

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

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.

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

MinimumHealthyHosts

The minimum number of healthy instances that should be available at any time during the deployment.

object? MinimumHealthyHosts { get; }

Property Value

object

Remarks

There are two parameters expected in the input: type and value.

The type parameter takes either of the following values:

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.

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

Type union: either IResolvable or CfnDeploymentConfig.IMinimumHealthyHostsProperty

TrafficRoutingConfig

The configuration that specifies how the deployment traffic is routed.

object? TrafficRoutingConfig { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnDeploymentConfig.ITrafficRoutingConfigProperty

ZonalConfig

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

object? ZonalConfig { get; }

Property Value

object

Remarks

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

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

Type union: either IResolvable or CfnDeploymentConfig.IZonalConfigProperty