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.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.CodeDeploy
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDeploymentConfig : CfnResource, IInspectable
Syntax (vb)
Public Class CfnDeploymentConfig
Inherits CfnResource
Implements IInspectable
Remarks
The deployment configuration specifies the number or percentage of instances that must remain available at any time during a deployment.
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(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDeploymentConfig(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDeploymentConfig(Construct, String, ICfnDeploymentConfigProps) |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ComputePlatform | The destination platform type for the deployment ( |
DeploymentConfigName | A name for the deployment configuration. |
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 |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDeploymentConfig(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDeploymentConfig(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDeploymentConfig(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDeploymentConfig(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDeploymentConfig(Construct, String, ICfnDeploymentConfigProps)
public CfnDeploymentConfig(Construct scope, string id, ICfnDeploymentConfigProps props = null)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDeploymentConfigProps
Resource properties.
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ComputePlatform
The destination platform type for the deployment ( Lambda
, Server
, or ECS
).
public virtual string ComputePlatform { get; set; }
Property Value
System.String
DeploymentConfigName
A name for the deployment configuration.
public virtual string DeploymentConfigName { get; set; }
Property Value
System.String
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
System.Object
TrafficRoutingConfig
The configuration that specifies how the deployment traffic is routed.
public virtual object TrafficRoutingConfig { get; set; }
Property Value
System.Object
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
System.Object
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>