Package software.amazon.awscdk.services.codedeploy

Class CfnDeploymentConfig

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.codedeploy.CfnDeploymentConfig
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:46.281Z") @Stability(Stable) public class CfnDeploymentConfig extends CfnResource implements IInspectable
A CloudFormation AWS::CodeDeploy::DeploymentConfig.

The AWS::CodeDeploy::DeploymentConfig resource creates a set of deployment rules, deployment success conditions, and deployment failure conditions that AWS CodeDeploy uses during a deployment. The deployment configuration specifies, through the use of a MinimumHealthyHosts value, the number or percentage of instances that must remain available at any time during a deployment.

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.*;
 CfnDeploymentConfig cfnDeploymentConfig = CfnDeploymentConfig.Builder.create(this, "MyCfnDeploymentConfig")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDeploymentConfig

      protected CfnDeploymentConfig(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDeploymentConfig

      protected CfnDeploymentConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDeploymentConfig

      @Stability(Stable) public CfnDeploymentConfig(@NotNull Construct scope, @NotNull String id, @Nullable CfnDeploymentConfigProps props)
      Create a new AWS::CodeDeploy::DeploymentConfig.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnDeploymentConfig

      @Stability(Stable) public CfnDeploymentConfig(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::CodeDeploy::DeploymentConfig.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getComputePlatform

      @Stability(Stable) @Nullable public String getComputePlatform()
      The destination platform type for the deployment ( Lambda , Server , or ECS ).

    • setComputePlatform

      @Stability(Stable) public void setComputePlatform(@Nullable String value)
      The destination platform type for the deployment ( Lambda , Server , or ECS ).

    • getDeploymentConfigName

      @Stability(Stable) @Nullable public 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.

    • setDeploymentConfigName

      @Stability(Stable) public void setDeploymentConfigName(@Nullable String value)
      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

      @Stability(Stable) @Nullable public 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.

    • setMinimumHealthyHosts

      @Stability(Stable) public void setMinimumHealthyHosts(@Nullable CfnDeploymentConfig.MinimumHealthyHostsProperty value)
      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.

    • setMinimumHealthyHosts

      @Stability(Stable) public void setMinimumHealthyHosts(@Nullable IResolvable value)
      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

      @Stability(Stable) @Nullable public Object getTrafficRoutingConfig()
      The configuration that specifies how the deployment traffic is routed.

    • setTrafficRoutingConfig

      @Stability(Stable) public void setTrafficRoutingConfig(@Nullable IResolvable value)
      The configuration that specifies how the deployment traffic is routed.

    • setTrafficRoutingConfig

      @Stability(Stable) public void setTrafficRoutingConfig(@Nullable CfnDeploymentConfig.TrafficRoutingConfigProperty value)
      The configuration that specifies how the deployment traffic is routed.