Package software.amazon.awscdk.services.codedeploy

Interface CfnDeploymentConfigProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeploymentConfigProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:12.929Z")
@Stability(Stable)
public interface CfnDeploymentConfigProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDeploymentConfig.

Example:

 // 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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDeploymentConfigProps.Builder	A builder for CfnDeploymentConfigProps
static final class	CfnDeploymentConfigProps.Jsii$Proxy	An implementation for CfnDeploymentConfigProps

Method Summary

Modifier and Type	Method	Description
static CfnDeploymentConfigProps.Builder	builder()
default String	getComputePlatform()	The destination platform type for the deployment ( Lambda , Server , or ECS ).
default String	getDeploymentConfigName()	A name for the deployment configuration.
default Object	getMinimumHealthyHosts()	The minimum number of healthy instances that should be available at any time during the deployment.
default Object	getTrafficRoutingConfig()	The configuration that specifies how the deployment traffic is routed.
default Object	getZonalConfig()	Configure the ZonalConfig object if you want AWS CodeDeploy to deploy your application to one Availability Zone at a time, within an AWS Region.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComputePlatform

@Stability(Stable)
@Nullable
default String getComputePlatform()

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

See Also:

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

getDeploymentConfigName

@Stability(Stable)
@Nullable
default String getDeploymentConfigName()

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 .

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 Also:

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

getMinimumHealthyHosts

@Stability(Stable)
@Nullable
default Object getMinimumHealthyHosts()

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.

See Also:

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

getTrafficRoutingConfig

@Stability(Stable)
@Nullable
default Object getTrafficRoutingConfig()

The configuration that specifies how the deployment traffic is routed.

See Also:

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

getZonalConfig

@Stability(Stable)
@Nullable
default Object getZonalConfig()

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

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

See Also:

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

builder

@Stability(Stable)
static CfnDeploymentConfigProps.Builder builder()

Returns:

a CfnDeploymentConfigProps.Builder of CfnDeploymentConfigProps