Class CfnDeploymentConfig

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.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnDeploymentConfig

Implements

IInspectable

IDeploymentConfigRef

IConstruct

IDependable

IEnvironmentAware

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.CodeDeploy

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDeploymentConfig : CfnResource, IInspectable, IDeploymentConfigRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnDeploymentConfig Inherits CfnResource Implements IInspectable, IDeploymentConfigRef, IConstruct, IDependable, IEnvironmentAware

Remarks

The deployment configuration specifies the number or percentage of instances that must remain available at any time during a deployment.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html

CloudformationResource: AWS::CodeDeploy::DeploymentConfig

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CodeDeploy;

             var cfnDeploymentConfig = new CfnDeploymentConfig(this, "MyCfnDeploymentConfig", new CfnDeploymentConfigProps {
                 ComputePlatform = "computePlatform",
                 DeploymentConfigName = "deploymentConfigName",
                 MinimumHealthyHosts = new MinimumHealthyHostsProperty {
                     Type = "type",
                     Value = 123
                 },
                 TrafficRoutingConfig = new TrafficRoutingConfigProperty {
                     Type = "type",

                     // the properties below are optional
                     TimeBasedCanary = new TimeBasedCanaryProperty {
                         CanaryInterval = 123,
                         CanaryPercentage = 123
                     },
                     TimeBasedLinear = new TimeBasedLinearProperty {
                         LinearInterval = 123,
                         LinearPercentage = 123
                     }
                 },
                 ZonalConfig = new ZonalConfigProperty {
                     FirstZoneMonitorDurationInSeconds = 123,
                     MinimumHealthyHostsPerZone = new MinimumHealthyHostsPerZoneProperty {
                         Type = "type",
                         Value = 123
                     },
                     MonitorDurationInSeconds = 123
                 }
             });

Synopsis

Constructors

CfnDeploymentConfig(Construct, string, ICfnDeploymentConfigProps?)

Create a new AWS::CodeDeploy::DeploymentConfig.

Properties

CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	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.
CfnPropertyNames	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.
ComputePlatform	The destination platform type for the deployment ( `Lambda` , `Server` , or `ECS` ).
DeploymentConfigName	A name for the deployment configuration.
DeploymentConfigRef	A reference to a DeploymentConfig resource.
MinimumHealthyHosts	The minimum number of healthy instances that should be available at any time during the deployment.
TrafficRoutingConfig	The configuration that specifies how the deployment traffic is routed.
ZonalConfig	Configure the `ZonalConfig` object if you want AWS CodeDeploy to deploy your application to one Availability Zone at a time, within an AWS Region.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnDeploymentConfig(object)	Checks whether the given object is a CfnDeploymentConfig.
RenderProperties(IDictionary<string, object>)	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.

Constructors

CfnDeploymentConfig(Construct, string, ICfnDeploymentConfigProps?)

Create a new AWS::CodeDeploy::DeploymentConfig.

public CfnDeploymentConfig(Construct scope, string id, ICfnDeploymentConfigProps? props = null)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnDeploymentConfigProps: Resource properties.

Remarks

The deployment configuration specifies the number or percentage of instances that must remain available at any time during a deployment.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html

CloudformationResource: AWS::CodeDeploy::DeploymentConfig

ExampleMetadata: fixture=_generated

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

The deployment configuration specifies the number or percentage of instances that must remain available at any time during a deployment.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html

CloudformationResource: AWS::CodeDeploy::DeploymentConfig

ExampleMetadata: fixture=_generated

CfnProperties

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.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

The deployment configuration specifies the number or percentage of instances that must remain available at any time during a deployment.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html

CloudformationResource: AWS::CodeDeploy::DeploymentConfig

ExampleMetadata: fixture=_generated

CfnPropertyNames

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.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

The deployment configuration specifies the number or percentage of instances that must remain available at any time during a deployment.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html

CloudformationResource: AWS::CodeDeploy::DeploymentConfig

ExampleMetadata: fixture=_generated

ComputePlatform

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

public virtual string? ComputePlatform { get; set; }

Property Value

string

Remarks

The deployment configuration specifies the number or percentage of instances that must remain available at any time during a deployment.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html

CloudformationResource: AWS::CodeDeploy::DeploymentConfig

ExampleMetadata: fixture=_generated

DeploymentConfigName

A name for the deployment configuration.

public virtual string? DeploymentConfigName { get; set; }

Property Value

string

Remarks

The deployment configuration specifies the number or percentage of instances that must remain available at any time during a deployment.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html

CloudformationResource: AWS::CodeDeploy::DeploymentConfig

ExampleMetadata: fixture=_generated

DeploymentConfigRef

A reference to a DeploymentConfig resource.

public virtual IDeploymentConfigReference DeploymentConfigRef { get; }

Property Value

IDeploymentConfigReference

Remarks

The deployment configuration specifies the number or percentage of instances that must remain available at any time during a deployment.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html

CloudformationResource: AWS::CodeDeploy::DeploymentConfig

ExampleMetadata: fixture=_generated

MinimumHealthyHosts

The minimum number of healthy instances that should be available at any time during the deployment.

public virtual object? MinimumHealthyHosts { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDeploymentConfig.IMinimumHealthyHostsProperty

TrafficRoutingConfig

The configuration that specifies how the deployment traffic is routed.

public virtual object? TrafficRoutingConfig { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDeploymentConfig.ITrafficRoutingConfigProperty

ZonalConfig

Configure the ZonalConfig object if you want AWS CodeDeploy to deploy your application to one Availability Zone at a time, within an AWS Region.

public virtual object? ZonalConfig { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDeploymentConfig.IZonalConfigProperty

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

Remarks

The deployment configuration specifies the number or percentage of instances that must remain available at any time during a deployment.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html

CloudformationResource: AWS::CodeDeploy::DeploymentConfig

ExampleMetadata: fixture=_generated

IsCfnDeploymentConfig(object)

Checks whether the given object is a CfnDeploymentConfig.

public static bool IsCfnDeploymentConfig(object x)

Parameters

x object

Returns

bool

Remarks

The deployment configuration specifies the number or percentage of instances that must remain available at any time during a deployment.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html

CloudformationResource: AWS::CodeDeploy::DeploymentConfig

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Remarks

The deployment configuration specifies the number or percentage of instances that must remain available at any time during a deployment.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html

CloudformationResource: AWS::CodeDeploy::DeploymentConfig

ExampleMetadata: fixture=_generated

Implements

IInspectable

IDeploymentConfigRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware