CfnDeploymentConfigProps Struct
Properties for defining a CfnDeploymentConfig.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codedeploy as codedeploy } from 'aws-cdk-lib';
const cfnDeploymentConfigProps: codedeploy.CfnDeploymentConfigProps = {
computePlatform: 'computePlatform',
deploymentConfigName: 'deploymentConfigName',
minimumHealthyHosts: {
type: 'type',
value: 123,
},
trafficRoutingConfig: {
type: 'type',
// the properties below are optional
timeBasedCanary: {
canaryInterval: 123,
canaryPercentage: 123,
},
timeBasedLinear: {
linearInterval: 123,
linearPercentage: 123,
},
},
zonalConfig: {
firstZoneMonitorDurationInSeconds: 123,
minimumHealthyHostsPerZone: {
type: 'type',
value: 123,
},
monitorDurationInSeconds: 123,
},
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import 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
)
),
zonal_config=codedeploy.CfnDeploymentConfig.ZonalConfigProperty(
first_zone_monitor_duration_in_seconds=123,
minimum_healthy_hosts_per_zone=codedeploy.CfnDeploymentConfig.MinimumHealthyHostsPerZoneProperty(
type="type",
value=123
),
monitor_duration_in_seconds=123
)
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.codedeploy.*;
CfnDeploymentConfigProps cfnDeploymentConfigProps = CfnDeploymentConfigProps.builder()
.computePlatform("computePlatform")
.deploymentConfigName("deploymentConfigName")
.minimumHealthyHosts(MinimumHealthyHostsProperty.builder()
.type("type")
.value(123)
.build())
.trafficRoutingConfig(TrafficRoutingConfigProperty.builder()
.type("type")
// the properties below are optional
.timeBasedCanary(TimeBasedCanaryProperty.builder()
.canaryInterval(123)
.canaryPercentage(123)
.build())
.timeBasedLinear(TimeBasedLinearProperty.builder()
.linearInterval(123)
.linearPercentage(123)
.build())
.build())
.zonalConfig(ZonalConfigProperty.builder()
.firstZoneMonitorDurationInSeconds(123)
.minimumHealthyHostsPerZone(MinimumHealthyHostsPerZoneProperty.builder()
.type("type")
.value(123)
.build())
.monitorDurationInSeconds(123)
.build())
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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
}
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnDeploymentConfigProps := &CfnDeploymentConfigProps{
ComputePlatform: jsii.String("computePlatform"),
DeploymentConfigName: jsii.String("deploymentConfigName"),
MinimumHealthyHosts: &MinimumHealthyHostsProperty{
Type: jsii.String("type"),
Value: jsii.Number(123),
},
TrafficRoutingConfig: &TrafficRoutingConfigProperty{
Type: jsii.String("type"),
// the properties below are optional
TimeBasedCanary: &TimeBasedCanaryProperty{
CanaryInterval: jsii.Number(123),
CanaryPercentage: jsii.Number(123),
},
TimeBasedLinear: &TimeBasedLinearProperty{
LinearInterval: jsii.Number(123),
LinearPercentage: jsii.Number(123),
},
},
ZonalConfig: &ZonalConfigProperty{
FirstZoneMonitorDurationInSeconds: jsii.Number(123),
MinimumHealthyHostsPerZone: &MinimumHealthyHostsPerZoneProperty{
Type: jsii.String("type"),
Value: jsii.Number(123),
},
MonitorDurationInSeconds: jsii.Number(123),
},
}
Properties
computePlatformoptionalstringcompute_platformoptionalstrcomputePlatformoptionalStringComputePlatformoptionalstringComputePlatformoptional*string#The destination platform type for the deployment ( `Lambda` , `Server` , or `ECS` ).
deploymentConfigNameoptionalstringdeployment_config_nameoptionalstrdeploymentConfigNameoptionalStringDeploymentConfigNameoptionalstringDeploymentConfigNameoptional*string#A name for the deployment configuration.
notes
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.
minimumHealthyHostsoptionalIResolvable | CfnDeploymentConfig.MinimumHealthyHostsPropertyminimum_healthy_hostsoptionaltyping.Union[IResolvable, MinimumHealthyHostsProperty]minimumHealthyHostsoptionalIResolvableMinimumHealthyHostsoptionalIResolvableMinimumHealthyHostsoptionalinterface{}#The minimum number of healthy instances that should be available at any time during the deployment.
notes
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.
trafficRoutingConfigoptionalIResolvable | CfnDeploymentConfig.TrafficRoutingConfigPropertytraffic_routing_configoptionaltyping.Union[IResolvable, TrafficRoutingConfigProperty]trafficRoutingConfigoptionalIResolvableTrafficRoutingConfigoptionalIResolvableTrafficRoutingConfigoptionalinterface{}#The configuration that specifies how the deployment traffic is routed.
zonalConfigoptionalIResolvable | CfnDeploymentConfig.ZonalConfigPropertyzonal_configoptionaltyping.Union[IResolvable, ZonalConfigProperty]zonalConfigoptionalIResolvableZonalConfigoptionalIResolvableZonalConfigoptionalinterface{}#Configure the `ZonalConfig` object if you want AWS CodeDeploy to deploy your application to one [Availability Zone](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-availability-zones) at a time, within an AWS Region.
For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User Guide .