AWS::SSMQuickSetup::LifecycleAutomation - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::SSMQuickSetup::LifecycleAutomation

Creates a lifecycle automation resource that executes SSM Automation documents during Amazon CloudFormation stack operations. This resource replaces inline Amazon Lambda custom resources and provides a managed way to handle lifecycle events in Quick Setup configurations.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::SSMQuickSetup::LifecycleAutomation",
  "Properties" : {
      "AutomationDocument" : String,
      "AutomationParameters" : {Key: Value, ...},
      "ResourceKey" : String,
      "Tags" : {Key: Value, ...}
    }
}

YAML

Type: AWS::SSMQuickSetup::LifecycleAutomation
Properties:
  AutomationDocument: String
  AutomationParameters: 
    Key: Value
  ResourceKey: String
  Tags: 
    Key: Value

Properties

AutomationDocument

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

Required: Yes

Type: String

Pattern: ^\S+$

Minimum: 1

Maximum: 500

Update requires: No interruption

AutomationParameters

A map of key-value parameters passed to the Automation document during execution. Each parameter name maps to a list of values, even for single values. Parameters can include configuration-specific values for your automation workflow.

Required: Yes

Type: Object of Array

Pattern: ^[a-zA-Z0-9_]+$

Update requires: No interruption

ResourceKey

A unique identifier used for generating the SSM Association name. This ensures uniqueness when multiple lifecycle automation resources exist in the same stack.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9-]+$

Minimum: 1

Maximum: 64

Update requires: Replacement

Tags

Tags applied to the underlying SSM Association created by this resource. Tags help identify and organize automation executions.

Required: No

Type: Object of String

Pattern: ^[A-Za-z0-9 +=@_\/:.-]+$

Minimum: 1

Maximum: 256

Update requires: No interruption

Return values

Ref

Returns the AssociationId of the lifecycle automation resource, which is the same as the association ID of the underlying Systems Manager association.

Fn::GetAtt

Returns the value of an attribute from the AWS::SSMQuickSetup::LifecycleAutomation resource. This resource executes SSM Automation documents in response to Amazon CloudFormation lifecycle events (CREATE, UPDATE, DELETE) and replaces inline Lambda custom resources in Quick Setup templates.

AssociationId

Returns the ID of the SSM Association created to manage the automation document execution lifecycle.