Class CfnLaunchConfigurationTemplate.SsmDocumentProperty

An AWS Systems Manager Document to execute as a post launch action.

Inheritance

object

CfnLaunchConfigurationTemplate.SsmDocumentProperty

Implements

CfnLaunchConfigurationTemplate.ISsmDocumentProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.MGN

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnLaunchConfigurationTemplate.SsmDocumentProperty : CfnLaunchConfigurationTemplate.ISsmDocumentProperty

Syntax (vb)

Public Class CfnLaunchConfigurationTemplate.SsmDocumentProperty Implements CfnLaunchConfigurationTemplate.ISsmDocumentProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-ssmdocument.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.MGN;

             var ssmDocumentProperty = new SsmDocumentProperty {
                 ActionName = "actionName",
                 SsmDocumentName = "ssmDocumentName",

                 // the properties below are optional
                 ExternalParameters = new Dictionary<string, object> {
                     { "externalParametersKey", new SsmExternalParameterProperty {
                         DynamicPath = "dynamicPath"
                     } }
                 },
                 MustSucceedForCutover = false,
                 Parameters = new Dictionary<string, object> {
                     { "parametersKey", new [] { new SsmParameterStoreParameterProperty {
                         ParameterName = "parameterName",
                         ParameterType = "parameterType"
                     } } }
                 },
                 TimeoutSeconds = 123
             };

Synopsis

Constructors

SsmDocumentProperty()

An AWS Systems Manager Document to execute as a post launch action.

Properties

ActionName	User-friendly name for the AWS Systems Manager Document.
ExternalParameters	AWS Systems Manager Document external parameters.
MustSucceedForCutover	Whether Cutover is blocked when the document has failed.
Parameters	AWS Systems Manager Document parameters, each resolved from AWS Systems Manager Parameter Store.
SsmDocumentName	AWS Systems Manager Document name or full ARN.
TimeoutSeconds	AWS Systems Manager Document timeout, in seconds.

Constructors

SsmDocumentProperty()

An AWS Systems Manager Document to execute as a post launch action.

public SsmDocumentProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-ssmdocument.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.MGN;

             var ssmDocumentProperty = new SsmDocumentProperty {
                 ActionName = "actionName",
                 SsmDocumentName = "ssmDocumentName",

                 // the properties below are optional
                 ExternalParameters = new Dictionary<string, object> {
                     { "externalParametersKey", new SsmExternalParameterProperty {
                         DynamicPath = "dynamicPath"
                     } }
                 },
                 MustSucceedForCutover = false,
                 Parameters = new Dictionary<string, object> {
                     { "parametersKey", new [] { new SsmParameterStoreParameterProperty {
                         ParameterName = "parameterName",
                         ParameterType = "parameterType"
                     } } }
                 },
                 TimeoutSeconds = 123
             };

Properties

ActionName

User-friendly name for the AWS Systems Manager Document.

public string ActionName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-ssmdocument.html#cfn-mgn-launchconfigurationtemplate-ssmdocument-actionname

ExternalParameters

AWS Systems Manager Document external parameters.

public object? ExternalParameters { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-ssmdocument.html#cfn-mgn-launchconfigurationtemplate-ssmdocument-externalparameters

Type union: either IResolvable or Dictionary<string, either IResolvable or CfnLaunchConfigurationTemplate.ISsmExternalParameterProperty>

MustSucceedForCutover

Whether Cutover is blocked when the document has failed.

public object? MustSucceedForCutover { get; set; }

Property Value

object

Remarks

Type union: either bool or IResolvable

Parameters

AWS Systems Manager Document parameters, each resolved from AWS Systems Manager Parameter Store.

public object? Parameters { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-ssmdocument.html#cfn-mgn-launchconfigurationtemplate-ssmdocument-parameters

Type union: either IResolvable or Dictionary<string, either IResolvable or (either IResolvable or CfnLaunchConfigurationTemplate.ISsmParameterStoreParameterProperty)[]>

SsmDocumentName

AWS Systems Manager Document name or full ARN.

public string SsmDocumentName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-ssmdocument.html#cfn-mgn-launchconfigurationtemplate-ssmdocument-ssmdocumentname

TimeoutSeconds

AWS Systems Manager Document timeout, in seconds.

public double? TimeoutSeconds { get; set; }