Class CfnDeployment

The AWS::AppConfig::Deployment resource starts a deployment.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnDeployment

Implements

IInspectable

IDeploymentRef

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.AddResourceDependency(CfnResource, string)

CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.RemoveResourceDependency(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.AppConfig

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDeployment : CfnResource, IInspectable, IDeploymentRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnDeployment Inherits CfnResource Implements IInspectable, IDeploymentRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Remarks

Starting a deployment in AWS AppConfig calls the StartDeployment API action. This call includes the IDs of the AWS AppConfig application, the environment, the configuration profile, and (optionally) the configuration data version to deploy. The call also includes the ID of the deployment strategy to use, which determines how the configuration data is deployed.

AWS AppConfig monitors the distribution to all hosts and reports status. If a distribution fails, then AWS AppConfig rolls back the configuration.

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-deployment.html

CloudformationResource: AWS::AppConfig::Deployment

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 cfnDeployment = new CfnDeployment(this, "MyCfnDeployment", new CfnDeploymentProps {
                 ApplicationId = "applicationId",
                 ConfigurationProfileId = "configurationProfileId",
                 ConfigurationVersion = "configurationVersion",
                 DeploymentStrategyId = "deploymentStrategyId",
                 EnvironmentId = "environmentId",

                 // the properties below are optional
                 Description = "description",
                 DynamicExtensionParameters = new [] { new DynamicExtensionParametersProperty {
                     ExtensionReference = "extensionReference",
                     ParameterName = "parameterName",
                     ParameterValue = "parameterValue"
                 } },
                 KmsKeyIdentifier = "kmsKeyIdentifier",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnDeployment(Construct, string, ICfnDeploymentProps)

Create a new AWS::AppConfig::Deployment.

Properties

ApplicationId	The application ID.
AttrDeploymentNumber	The sequence number of the deployment.
AttrState	The state of the deployment.
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::Deployment` resource starts a deployment.
CfnPropertyNames	The `AWS::AppConfig::Deployment` resource starts a deployment.
ConfigurationProfileId	The configuration profile ID.
ConfigurationVersion	The configuration version to deploy.
DeploymentRef	A reference to a Deployment resource.
DeploymentStrategyId	The deployment strategy ID.
Description	A description of the deployment.
DynamicExtensionParameters	A map of dynamic extension parameter names to values to pass to associated extensions with `PRE_START_DEPLOYMENT` actions.
EnvironmentId	The environment ID.
KmsKeyIdentifier	The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
Tags	Metadata to assign to the deployment.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnDeployment(object)	Checks whether the given object is a CfnDeployment.
RenderProperties(IDictionary<string, object>)	The `AWS::AppConfig::Deployment` resource starts a deployment.

Constructors

CfnDeployment(Construct, string, ICfnDeploymentProps)

Create a new AWS::AppConfig::Deployment.

public CfnDeployment(Construct scope, string id, ICfnDeploymentProps props)

Parameters

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

Remarks

AWS AppConfig monitors the distribution to all hosts and reports status. If a distribution fails, then AWS AppConfig rolls back the configuration.

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-deployment.html

CloudformationResource: AWS::AppConfig::Deployment

ExampleMetadata: fixture=_generated

Properties

ApplicationId

The application ID.

public virtual string ApplicationId { get; set; }

Property Value

string

Remarks

AWS AppConfig monitors the distribution to all hosts and reports status. If a distribution fails, then AWS AppConfig rolls back the configuration.

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-deployment.html

CloudformationResource: AWS::AppConfig::Deployment

ExampleMetadata: fixture=_generated

AttrDeploymentNumber

The sequence number of the deployment.

public virtual string AttrDeploymentNumber { get; }

Property Value

string

Remarks

CloudformationAttribute: DeploymentNumber

AttrState

The state of the deployment.

public virtual string AttrState { get; }

Property Value

string

Remarks

CloudformationAttribute: State

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

AWS AppConfig monitors the distribution to all hosts and reports status. If a distribution fails, then AWS AppConfig rolls back the configuration.

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-deployment.html

CloudformationResource: AWS::AppConfig::Deployment

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

AWS AppConfig monitors the distribution to all hosts and reports status. If a distribution fails, then AWS AppConfig rolls back the configuration.

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-deployment.html

CloudformationResource: AWS::AppConfig::Deployment

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::AppConfig::Deployment resource starts a deployment.

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

AWS AppConfig monitors the distribution to all hosts and reports status. If a distribution fails, then AWS AppConfig rolls back the configuration.

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-deployment.html

CloudformationResource: AWS::AppConfig::Deployment

ExampleMetadata: fixture=_generated

CfnPropertyNames

The AWS::AppConfig::Deployment resource starts a deployment.

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

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

AWS AppConfig monitors the distribution to all hosts and reports status. If a distribution fails, then AWS AppConfig rolls back the configuration.

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-deployment.html

CloudformationResource: AWS::AppConfig::Deployment

ExampleMetadata: fixture=_generated

ConfigurationProfileId

The configuration profile ID.

public virtual string ConfigurationProfileId { get; set; }

Property Value

string

Remarks

AWS AppConfig monitors the distribution to all hosts and reports status. If a distribution fails, then AWS AppConfig rolls back the configuration.

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-deployment.html

CloudformationResource: AWS::AppConfig::Deployment

ExampleMetadata: fixture=_generated

ConfigurationVersion

The configuration version to deploy.

public virtual string ConfigurationVersion { get; set; }

Property Value

string

Remarks

AWS AppConfig monitors the distribution to all hosts and reports status. If a distribution fails, then AWS AppConfig rolls back the configuration.

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-deployment.html

CloudformationResource: AWS::AppConfig::Deployment

ExampleMetadata: fixture=_generated

DeploymentRef

A reference to a Deployment resource.

public virtual IDeploymentReference DeploymentRef { get; }

Property Value

IDeploymentReference

Remarks

AWS AppConfig monitors the distribution to all hosts and reports status. If a distribution fails, then AWS AppConfig rolls back the configuration.

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-deployment.html

CloudformationResource: AWS::AppConfig::Deployment

ExampleMetadata: fixture=_generated

DeploymentStrategyId

The deployment strategy ID.

public virtual string DeploymentStrategyId { get; set; }

Property Value

string

Remarks

AWS AppConfig monitors the distribution to all hosts and reports status. If a distribution fails, then AWS AppConfig rolls back the configuration.

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-deployment.html

CloudformationResource: AWS::AppConfig::Deployment

ExampleMetadata: fixture=_generated

Description

A description of the deployment.

public virtual string? Description { get; set; }

Property Value

string

Remarks

AWS AppConfig monitors the distribution to all hosts and reports status. If a distribution fails, then AWS AppConfig rolls back the configuration.

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-deployment.html

CloudformationResource: AWS::AppConfig::Deployment

ExampleMetadata: fixture=_generated

DynamicExtensionParameters

A map of dynamic extension parameter names to values to pass to associated extensions with PRE_START_DEPLOYMENT actions.

public virtual object? DynamicExtensionParameters { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnDeployment.IDynamicExtensionParametersProperty)[]

EnvironmentId

The environment ID.

public virtual string EnvironmentId { get; set; }

Property Value

string

Remarks

AWS AppConfig monitors the distribution to all hosts and reports status. If a distribution fails, then AWS AppConfig rolls back the configuration.

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-deployment.html

CloudformationResource: AWS::AppConfig::Deployment

ExampleMetadata: fixture=_generated

KmsKeyIdentifier

The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.

public virtual string? KmsKeyIdentifier { get; set; }

Property Value

string

Remarks

AWS AppConfig monitors the distribution to all hosts and reports status. If a distribution fails, then AWS AppConfig rolls back the configuration.

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-deployment.html

CloudformationResource: AWS::AppConfig::Deployment

ExampleMetadata: fixture=_generated

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

AWS AppConfig monitors the distribution to all hosts and reports status. If a distribution fails, then AWS AppConfig rolls back the configuration.

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-deployment.html

CloudformationResource: AWS::AppConfig::Deployment

ExampleMetadata: fixture=_generated

IsCfnDeployment(object)

Checks whether the given object is a CfnDeployment.

public static bool IsCfnDeployment(object x)

Parameters

x object

Returns

bool

Remarks

AWS AppConfig monitors the distribution to all hosts and reports status. If a distribution fails, then AWS AppConfig rolls back the configuration.

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-deployment.html

CloudformationResource: AWS::AppConfig::Deployment

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::AppConfig::Deployment resource starts a deployment.

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

Remarks

AWS AppConfig monitors the distribution to all hosts and reports status. If a distribution fails, then AWS AppConfig rolls back the configuration.

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-deployment.html

CloudformationResource: AWS::AppConfig::Deployment

ExampleMetadata: fixture=_generated

Implements

IInspectable

IDeploymentRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2