Interface ICfnLifecycleAutomationProps

Properties for defining a CfnLifecycleAutomation.

Namespace: Amazon.CDK.AWS.SSMQuickSetup

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnLifecycleAutomationProps

Syntax (vb)

Public Interface ICfnLifecycleAutomationProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmquicksetup-lifecycleautomation.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.SSMQuickSetup;

             var cfnLifecycleAutomationProps = new CfnLifecycleAutomationProps {
                 AutomationDocument = "automationDocument",
                 AutomationParameters = new Dictionary<string, string[]> {
                     { "automationParametersKey", new [] { "automationParameters" } }
                 },
                 ResourceKey = "resourceKey",

                 // the properties below are optional
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             };

Synopsis

Properties

AutomationDocument	The name of the SSM Automation document to execute in response to CloudFormation lifecycle events (CREATE, UPDATE, DELETE).
AutomationParameters	A map of key-value parameters passed to the Automation document during execution.
ResourceKey	A unique identifier used for generating the SSM Association name.
Tags	Tags applied to the underlying SSM Association created by this resource.

Properties

AutomationDocument

The name of the SSM Automation document to execute in response to CloudFormation lifecycle events (CREATE, UPDATE, DELETE).

string AutomationDocument { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmquicksetup-lifecycleautomation.html#cfn-ssmquicksetup-lifecycleautomation-automationdocument

AutomationParameters

A map of key-value parameters passed to the Automation document during execution.

object AutomationParameters { get; }

Property Value

object

Remarks

Each parameter name maps to a list of values, even for single values. Parameters can include configuration-specific values for your automation workflow.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmquicksetup-lifecycleautomation.html#cfn-ssmquicksetup-lifecycleautomation-automationparameters

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

ResourceKey

A unique identifier used for generating the SSM Association name.

string ResourceKey { get; }

Property Value

string

Remarks

This ensures uniqueness when multiple lifecycle automation resources exist in the same stack.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmquicksetup-lifecycleautomation.html#cfn-ssmquicksetup-lifecycleautomation-resourcekey