Class CfnDeploymentStrategy

The AWS::AppConfig::DeploymentStrategy resource creates an AWS AppConfig deployment strategy.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnDeploymentStrategy

Implements

IInspectable

IDeploymentStrategyRef

IConstruct

IDependable

IEnvironmentAware

ITaggableV2

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.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.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.AppConfig

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDeploymentStrategy : CfnResource, IInspectable, IDeploymentStrategyRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnDeploymentStrategy Inherits CfnResource Implements IInspectable, IDeploymentStrategyRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html

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

CfnDeploymentStrategy(Construct, string, ICfnDeploymentStrategyProps)

Create a new AWS::AppConfig::DeploymentStrategy.

Properties

AttrId	The deployment strategy ID.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	The AWS::AppConfig::DeploymentStrategy resource creates an AWS AppConfig deployment strategy.
DeploymentDurationInMinutes	Total amount of time for a deployment to last.
DeploymentStrategyRef	A reference to a DeploymentStrategy resource.
Description	A description of the deployment strategy.
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.
GrowthFactor	The percentage of targets to receive a deployed configuration during each interval.
GrowthType	The algorithm used to define how percentage grows over time.
Name	A name for the deployment strategy.
ReplicateTo	Save the deployment strategy to a Systems Manager (SSM) document.
Tags	Assigns metadata to an AWS AppConfig resource.

Methods

ArnForDeploymentStrategy(IDeploymentStrategyRef)	The AWS::AppConfig::DeploymentStrategy resource creates an AWS AppConfig deployment strategy.
FromDeploymentStrategyId(Construct, string, string)	Creates a new IDeploymentStrategyRef from a deploymentStrategyId.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnDeploymentStrategy(object)	Checks whether the given object is a CfnDeploymentStrategy.
RenderProperties(IDictionary<string, object>)	The AWS::AppConfig::DeploymentStrategy resource creates an AWS AppConfig deployment strategy.

Constructors

CfnDeploymentStrategy(Construct, string, ICfnDeploymentStrategyProps)

Create a new AWS::AppConfig::DeploymentStrategy.

public CfnDeploymentStrategy(Construct scope, string id, ICfnDeploymentStrategyProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnDeploymentStrategyProps

Resource properties.

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html

CloudformationResource: AWS::AppConfig::DeploymentStrategy

ExampleMetadata: fixture=_generated

Properties

AttrId

The deployment strategy ID.

public virtual string AttrId { get; }

Property Value

string

Remarks

CloudformationAttribute: Id

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

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html

CloudformationResource: AWS::AppConfig::DeploymentStrategy

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html

CloudformationResource: AWS::AppConfig::DeploymentStrategy

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::AppConfig::DeploymentStrategy resource creates an AWS AppConfig deployment strategy.

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html

CloudformationResource: AWS::AppConfig::DeploymentStrategy

ExampleMetadata: fixture=_generated

DeploymentDurationInMinutes

Total amount of time for a deployment to last.

public virtual double DeploymentDurationInMinutes { get; set; }

Property Value

double

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html

CloudformationResource: AWS::AppConfig::DeploymentStrategy

ExampleMetadata: fixture=_generated

DeploymentStrategyRef

A reference to a DeploymentStrategy resource.

public virtual IDeploymentStrategyReference DeploymentStrategyRef { get; }

Property Value

IDeploymentStrategyReference

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html

CloudformationResource: AWS::AppConfig::DeploymentStrategy

ExampleMetadata: fixture=_generated

Description

A description of the deployment strategy.

public virtual string? Description { get; set; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html

CloudformationResource: AWS::AppConfig::DeploymentStrategy

ExampleMetadata: fixture=_generated

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 double? FinalBakeTimeInMinutes { get; set; }

Property Value

double?

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html

CloudformationResource: AWS::AppConfig::DeploymentStrategy

ExampleMetadata: fixture=_generated

GrowthFactor

The percentage of targets to receive a deployed configuration during each interval.

public virtual double GrowthFactor { get; set; }

Property Value

double

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html

CloudformationResource: AWS::AppConfig::DeploymentStrategy

ExampleMetadata: fixture=_generated

GrowthType

The algorithm used to define how percentage grows over time.

public virtual string? GrowthType { get; set; }

Property Value

string

Remarks

AWS AppConfig supports the following growth types:.

Name

A name for the deployment strategy.

public virtual string Name { get; set; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html

CloudformationResource: AWS::AppConfig::DeploymentStrategy

ExampleMetadata: fixture=_generated

ReplicateTo

Save the deployment strategy to a Systems Manager (SSM) document.

public virtual string ReplicateTo { get; set; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html

CloudformationResource: AWS::AppConfig::DeploymentStrategy

ExampleMetadata: fixture=_generated

Tags

Assigns metadata to an AWS AppConfig resource.

public virtual ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html

CloudformationResource: AWS::AppConfig::DeploymentStrategy

ExampleMetadata: fixture=_generated

Methods

ArnForDeploymentStrategy(IDeploymentStrategyRef)

The AWS::AppConfig::DeploymentStrategy resource creates an AWS AppConfig deployment strategy.

public static string ArnForDeploymentStrategy(IDeploymentStrategyRef resource)

Parameters

resource IDeploymentStrategyRef

Returns

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html

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"
                 } }
             });

FromDeploymentStrategyId(Construct, string, string)

Creates a new IDeploymentStrategyRef from a deploymentStrategyId.

public static IDeploymentStrategyRef FromDeploymentStrategyId(Construct scope, string id, string deploymentStrategyId)

Parameters

scope Construct

id string

deploymentStrategyId string

Returns

IDeploymentStrategyRef

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html

CloudformationResource: AWS::AppConfig::DeploymentStrategy

ExampleMetadata: fixture=_generated

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

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html

CloudformationResource: AWS::AppConfig::DeploymentStrategy

ExampleMetadata: fixture=_generated

IsCfnDeploymentStrategy(object)

Checks whether the given object is a CfnDeploymentStrategy.

public static bool IsCfnDeploymentStrategy(object x)

Parameters

x object

Returns

bool

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html

CloudformationResource: AWS::AppConfig::DeploymentStrategy

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::AppConfig::DeploymentStrategy resource creates an AWS AppConfig deployment strategy.

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

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html

CloudformationResource: AWS::AppConfig::DeploymentStrategy

ExampleMetadata: fixture=_generated

Implements

IInspectable

IDeploymentStrategyRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2