Class CfnDeploymentStrategy
The AWS::AppConfig::DeploymentStrategy resource creates an AWS AppConfig deployment strategy.
Inherited Members
Namespace: Amazon.CDK.AWS.AppConfig
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDeploymentStrategy : CfnResource, IInspectable, ITaggableV2Syntax (vb)
Public Class CfnDeploymentStrategy
Inherits CfnResource
Implements IInspectable, ITaggableV2Remarks
A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes: the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.
AWS AppConfig requires that you create resources and deploy a configuration in the following order:
For more information, see AWS AppConfig in the AWS AppConfig User Guide .
CloudformationResource: AWS::AppConfig::DeploymentStrategy
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.AppConfig;
var cfnDeploymentStrategy = new CfnDeploymentStrategy(this, "MyCfnDeploymentStrategy", new CfnDeploymentStrategyProps {
DeploymentDurationInMinutes = 123,
GrowthFactor = 123,
Name = "name",
ReplicateTo = "replicateTo",
// the properties below are optional
Description = "description",
FinalBakeTimeInMinutes = 123,
GrowthType = "growthType",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});Synopsis
Constructors
| Cfn |
Used by jsii to construct an instance of this class from a Javascript-owned object reference |
| Cfn |
Used by jsii to construct an instance of this class from DeputyProps |
| Cfn |
Properties
| Attr |
The deployment strategy ID. |
| Cdk |
Tag Manager which manages the tags for this resource. |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| Cfn |
|
| Deployment |
Total amount of time for a deployment to last. |
| Description | A description of the deployment strategy. |
| Final |
Specifies the amount of time AWS AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete. |
| Growth |
The percentage of targets to receive a deployed configuration during each interval. |
| Growth |
The algorithm used to define how percentage grows over time. |
| Name | A name for the deployment strategy. |
| Replicate |
Save the deployment strategy to a Systems Manager (SSM) document. |
| Tags | Assigns metadata to an AWS AppConfig resource. |
Methods
| Inspect(Tree |
Examines the CloudFormation resource and discloses attributes. |
| RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDeploymentStrategy(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDeploymentStrategy(ByRefValue reference)Parameters
- reference Amazon.
JSII. Runtime. Deputy. By Ref Value The Javascript-owned object reference
CfnDeploymentStrategy(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDeploymentStrategy(DeputyBase.DeputyProps props)Parameters
- props Amazon.
JSII. Runtime. Deputy. Deputy Base. Deputy Props The deputy props
CfnDeploymentStrategy(Construct, String, ICfnDeploymentStrategyProps)
public CfnDeploymentStrategy(Construct scope, string id, ICfnDeploymentStrategyProps props)Parameters
- scope Constructs.
Construct Scope in which this resource is defined.
- id System.
String Construct identifier for this resource (unique in its scope).
- props ICfn
Deployment Strategy Props Resource properties.
Properties
AttrId
The deployment strategy ID.
public virtual string AttrId { get; }Property Value
System.
Remarks
CloudformationAttribute: Id
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }Property Value
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }Property Value
System.
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }Property Value
System.
Overrides
DeploymentDurationInMinutes
Total amount of time for a deployment to last.
public virtual double DeploymentDurationInMinutes { get; set; }Property Value
System.
Description
A description of the deployment strategy.
public virtual string Description { get; set; }Property Value
System.
FinalBakeTimeInMinutes
Specifies the amount of time AWS AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete.
public virtual Nullable<double> FinalBakeTimeInMinutes { get; set; }Property Value
System.
GrowthFactor
The percentage of targets to receive a deployed configuration during each interval.
public virtual double GrowthFactor { get; set; }Property Value
System.
GrowthType
The algorithm used to define how percentage grows over time.
public virtual string GrowthType { get; set; }Property Value
System.
Remarks
AWS AppConfig supports the following growth types:.
Name
A name for the deployment strategy.
public virtual string Name { get; set; }Property Value
System.
ReplicateTo
Save the deployment strategy to a Systems Manager (SSM) document.
public virtual string ReplicateTo { get; set; }Property Value
System.
Tags
Assigns metadata to an AWS AppConfig resource.
public virtual ICfnTag[] Tags { get; set; }Property Value
ICfn
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)Parameters
- inspector Tree
Inspector 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. <System.Generic. IDictionary String , System.Object >
Returns
System.