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:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.72.0 (build 4b8828b)",
           date="2022-12-21T20:56:32.564Z")
 @Stability(value=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();
 

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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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 String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDeploymentConfig(Construct scope, String id) Create a new `AWS::CodeDeploy::DeploymentConfig`.
	CfnDeploymentConfig(Construct scope, 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

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getComputePlatform() The destination platform type for the deployment ( `Lambda` , `Server` , or `ECS` ).
String	getDeploymentConfigName() A name for the deployment configuration.
Object	getMinimumHealthyHosts() The minimum number of healthy instances that should be available at any time during the deployment.
Object	getTrafficRoutingConfig() The configuration that specifies how the deployment traffic is routed.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setComputePlatform(String value) The destination platform type for the deployment ( `Lambda` , `Server` , or `ECS` ).
void	setDeploymentConfigName(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 software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=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(value=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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getComputePlatform

@Stability(value=Stable)
 @Nullable
public String getComputePlatform()

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

setComputePlatform

@Stability(value=Stable)
public void setComputePlatform(@Nullable
                                                        String value)

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

getDeploymentConfigName

@Stability(value=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(value=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(value=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(value=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(value=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(value=Stable)
 @Nullable
public Object getTrafficRoutingConfig()

The configuration that specifies how the deployment traffic is routed.

setTrafficRoutingConfig

@Stability(value=Stable)
public void setTrafficRoutingConfig(@Nullable
                                                             IResolvable value)

The configuration that specifies how the deployment traffic is routed.

setTrafficRoutingConfig

@Stability(value=Stable)
public void setTrafficRoutingConfig(@Nullable
                                                             CfnDeploymentConfig.TrafficRoutingConfigProperty value)

The configuration that specifies how the deployment traffic is routed.