CfnDeploymentConfig

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

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-18T02:14:15.141Z")
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();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnDeploymentConfig.Builder` A fluent builder for `CfnDeploymentConfig`.
`static interface`	`CfnDeploymentConfig.MinimumHealthyHostsProperty` `MinimumHealthyHosts` is a property of the [DeploymentConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html) resource that defines how many instances must remain healthy during an AWS CodeDeploy deployment.
`static interface`	`CfnDeploymentConfig.TimeBasedCanaryProperty` A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in two increments.
`static interface`	`CfnDeploymentConfig.TimeBasedLinearProperty` A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in equal increments, with an equal number of minutes between each increment.
`static interface`	`CfnDeploymentConfig.TrafficRoutingConfigProperty` The configuration that specifies how traffic is shifted from one version of a Lambda function to another version during an AWS Lambda deployment, or from one Amazon ECS task set to another during an Amazon ECS deployment.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnDeploymentConfig(Construct scope, java.lang.String id)` Create a new `AWS::CodeDeploy::DeploymentConfig`.
	`CfnDeploymentConfig(Construct scope, java.lang.String id, CfnDeploymentConfigProps props)` Create a new `AWS::CodeDeploy::DeploymentConfig`.
`protected`	`CfnDeploymentConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnDeploymentConfig(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getComputePlatform()` The destination platform type for the deployment ( `Lambda` , `Server` , or `ECS` ).
`java.lang.String`	`getDeploymentConfigName()` A name for the deployment configuration.
`java.lang.Object`	`getMinimumHealthyHosts()` The minimum number of healthy instances that should be available at any time during the deployment.
`java.lang.Object`	`getTrafficRoutingConfig()` The configuration that specifies how the deployment traffic is routed.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setComputePlatform(java.lang.String value)` The destination platform type for the deployment ( `Lambda` , `Server` , or `ECS` ).
`void`	`setDeploymentConfigName(java.lang.String value)` A name for the deployment configuration.
`void`	`setMinimumHealthyHosts(CfnDeploymentConfig.MinimumHealthyHostsProperty value)` The minimum number of healthy instances that should be available at any time during the deployment.
`void`	`setMinimumHealthyHosts(IResolvable value)` The minimum number of healthy instances that should be available at any time during the deployment.
`void`	`setTrafficRoutingConfig(CfnDeploymentConfig.TrafficRoutingConfigProperty value)` The configuration that specifies how the deployment traffic is routed.
`void`	`setTrafficRoutingConfig(IResolvable value)` The configuration that specifies how the deployment traffic is routed.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnDeploymentConfig
```
protected CfnDeploymentConfig(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnDeploymentConfig
```
protected CfnDeploymentConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnDeploymentConfig
```
public CfnDeploymentConfig(Construct scope,
                           java.lang.String id,
                           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
```
public CfnDeploymentConfig(Construct scope,
                           java.lang.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 Detail
  - inspect
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getComputePlatform
```
public java.lang.String getComputePlatform()
```
    The destination platform type for the deployment ( `Lambda` , `Server` , or `ECS` ).
  - setComputePlatform
```
public void setComputePlatform(java.lang.String value)
```
    The destination platform type for the deployment ( `Lambda` , `Server` , or `ECS` ).
  - getDeploymentConfigName
```
public 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.
  - setDeploymentConfigName
```
public void setDeploymentConfigName(java.lang.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
```
public 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.
  - setMinimumHealthyHosts
```
public void setMinimumHealthyHosts(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
```
public void setMinimumHealthyHosts(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
```
public java.lang.Object getTrafficRoutingConfig()
```
    The configuration that specifies how the deployment traffic is routed.
  - setTrafficRoutingConfig
```
public void setTrafficRoutingConfig(IResolvable value)
```
    The configuration that specifies how the deployment traffic is routed.
  - setTrafficRoutingConfig
```
public void setTrafficRoutingConfig(CfnDeploymentConfig.TrafficRoutingConfigProperty value)
```
    The configuration that specifies how the deployment traffic is routed.

Class CfnDeploymentConfig

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnDeploymentConfig

CfnDeploymentConfig

CfnDeploymentConfig

CfnDeploymentConfig

Method Detail

inspect

renderProperties

getCfnProperties

getComputePlatform

setComputePlatform

getDeploymentConfigName

setDeploymentConfigName

getMinimumHealthyHosts

setMinimumHealthyHosts

setMinimumHealthyHosts

getTrafficRoutingConfig

setTrafficRoutingConfig

setTrafficRoutingConfig