Package software.amazon.awscdk.services.codedeploy

Class CfnDeploymentConfig

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.codedeploy.CfnDeploymentConfig
All Implemented Interfaces:
IInspectable, IDeploymentConfigRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:33.599Z") @Stability(Stable) public class CfnDeploymentConfig extends CfnResource implements IInspectable, IDeploymentConfigRef
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 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())
         .zonalConfig(ZonalConfigProperty.builder()
                 .firstZoneMonitorDurationInSeconds(123)
                 .minimumHealthyHostsPerZone(MinimumHealthyHostsPerZoneProperty.builder()
                         .type("type")
                         .value(123)
                         .build())
                 .monitorDurationInSeconds(123)
                 .build())
         .build();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @Nullable CfnDeploymentConfigProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnDeploymentConfig

      @Stability(Stable) public CfnDeploymentConfig(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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

    • getDeploymentConfigRef

      @Stability(Stable) @NotNull public DeploymentConfigReference getDeploymentConfigRef()
      A reference to a DeploymentConfig resource.
      Specified by:
      getDeploymentConfigRef in interface IDeploymentConfigRef

    • 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.

    • setDeploymentConfigName

      @Stability(Stable) public void setDeploymentConfigName(@Nullable String value)
      A name for the deployment configuration.

    • getMinimumHealthyHosts

      @Stability(Stable) @Nullable public Object getMinimumHealthyHosts()
      The minimum number of healthy instances that should be available at any time during the deployment.

      Returns union: either IResolvable or CfnDeploymentConfig.MinimumHealthyHostsProperty

    • 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.

    • 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.

    • getTrafficRoutingConfig

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

      Returns union: either IResolvable or CfnDeploymentConfig.TrafficRoutingConfigProperty

    • 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.

    • getZonalConfig

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

      Returns union: either IResolvable or CfnDeploymentConfig.ZonalConfigProperty

    • setZonalConfig

      @Stability(Stable) public void setZonalConfig(@Nullable IResolvable value)
      Configure the ZonalConfig object if you want AWS CodeDeploy to deploy your application to one Availability Zone at a time, within an AWS Region.

    • setZonalConfig

      @Stability(Stable) public void setZonalConfig(@Nullable CfnDeploymentConfig.ZonalConfigProperty value)
      Configure the ZonalConfig object if you want AWS CodeDeploy to deploy your application to one Availability Zone at a time, within an AWS Region.