Interface ICfnDeploymentProps

Properties for defining a CfnDeployment.

Namespace: Amazon.CDK.AWS.AppConfig

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnDeploymentProps

Syntax (vb)

Public Interface ICfnDeploymentProps

Remarks

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

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 cfnDeploymentProps = 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

Properties

ApplicationId	The application ID.
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 `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.

Properties

ApplicationId

The application ID.

string ApplicationId { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-applicationid

ConfigurationProfileId

The configuration profile ID.

string ConfigurationProfileId { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-configurationprofileid

ConfigurationVersion

The configuration version to deploy.

string ConfigurationVersion { get; }

Property Value

string

Remarks

If deploying an AWS AppConfig hosted configuration version, you can specify either the version number or version label. For all other configurations, you must specify the version number.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-configurationversion

DeploymentStrategyId

The deployment strategy ID.

string DeploymentStrategyId { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-deploymentstrategyid

Description

A description of the deployment.

string? Description { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-description

DynamicExtensionParameters

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

object? DynamicExtensionParameters { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-dynamicextensionparameters

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

EnvironmentId

The environment ID.

string EnvironmentId { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-environmentid

KmsKeyIdentifier

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

string? KmsKeyIdentifier { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-kmskeyidentifier