Class CfnDeployment
The AWS::AppConfig::Deployment
resource starts a deployment.
Inherited Members
Namespace: Amazon.CDK.AWS.AppConfig
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDeployment : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnDeployment
Inherits CfnResource
Implements IInspectable, 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(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDeployment(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDeployment(Construct, String, ICfnDeploymentProps) |
Properties
ApplicationId | The application ID. |
AttrId | |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ConfigurationProfileId | The configuration profile ID. |
ConfigurationVersion | The configuration version to deploy. |
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 |
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. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDeployment(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDeployment(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDeployment(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDeployment(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDeployment(Construct, String, ICfnDeploymentProps)
public CfnDeployment(Construct scope, string id, ICfnDeploymentProps 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 ICfnDeploymentProps
Resource properties.
Properties
ApplicationId
The application ID.
public virtual string ApplicationId { get; set; }
Property Value
System.String
AttrId
public virtual string AttrId { get; }
Property Value
System.String
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.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ConfigurationProfileId
The configuration profile ID.
public virtual string ConfigurationProfileId { get; set; }
Property Value
System.String
ConfigurationVersion
The configuration version to deploy.
public virtual string ConfigurationVersion { get; set; }
Property Value
System.String
DeploymentStrategyId
The deployment strategy ID.
public virtual string DeploymentStrategyId { get; set; }
Property Value
System.String
Description
A description of the deployment.
public virtual string Description { get; set; }
Property Value
System.String
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
System.Object
EnvironmentId
The environment ID.
public virtual string EnvironmentId { get; set; }
Property Value
System.String
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
System.String
Tags
Metadata to assign to the deployment.
public virtual ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
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>