software.amazon.awscdk.services.codedeploy

Interface CfnDeploymentConfigProps

All Known Implementing Classes:

CfnDeploymentConfigProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:59.389Z")
public interface CfnDeploymentConfigProps

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())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDeploymentConfigProps.Builder	builder()
default java.lang.String	getComputePlatform() The destination platform type for the deployment ( `Lambda` , `Server` , or `ECS` ).
default java.lang.String	getDeploymentConfigName() A name for the deployment configuration.
default java.lang.Object	getMinimumHealthyHosts() The minimum number of healthy instances that should be available at any time during the deployment.
default java.lang.Object	getTrafficRoutingConfig() The configuration that specifies how the deployment traffic is routed.

Method Detail

getComputePlatform

default java.lang.String getComputePlatform()

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

getDeploymentConfigName

default java.lang.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.

getMinimumHealthyHosts

default java.lang.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.

getTrafficRoutingConfig

default java.lang.Object getTrafficRoutingConfig()

The configuration that specifies how the deployment traffic is routed.

builder

static CfnDeploymentConfigProps.Builder builder()

Returns:

a CfnDeploymentConfigProps.Builder of CfnDeploymentConfigProps