interface CfnLifecycleAutomationProps

Language	Type name
.NET	`Amazon.CDK.aws_ssmquicksetup.CfnLifecycleAutomationProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsssmquicksetup#CfnLifecycleAutomationProps`
Java	`software.amazon.awscdk.services.ssmquicksetup.CfnLifecycleAutomationProps`
Python	`aws_cdk.aws_ssmquicksetup.CfnLifecycleAutomationProps`
TypeScript	`aws-cdk-lib` » `aws_ssmquicksetup` » `CfnLifecycleAutomationProps`

Properties for defining a CfnLifecycleAutomation.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ssmquicksetup as ssmquicksetup } from 'aws-cdk-lib';
const cfnLifecycleAutomationProps: ssmquicksetup.CfnLifecycleAutomationProps = {
  automationDocument: 'automationDocument',
  automationParameters: {
    automationParametersKey: ['automationParameters'],
  },
  resourceKey: 'resourceKey',

  // the properties below are optional
  tags: {
    tagsKey: 'tags',
  },
};

Properties

Name	Type	Description
automationDocument	`string`	The name of the SSM Automation document to execute in response to AWS CloudFormation lifecycle events (CREATE, UPDATE, DELETE).
automationParameters	`IResolvable` `\| { [string]: string[] }`	A map of key-value parameters passed to the Automation document during execution.
resourceKey	`string`	A unique identifier used for generating the SSM Association name.
tags?	`{ [string]: string }`	Tags applied to the underlying SSM Association created by this resource.

automationDocument

Type: string

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

automationParameters

Type: IResolvable | { [string]: string[] }

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.

resourceKey

Type: string

A unique identifier used for generating the SSM Association name.

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

tags?

Type: { [string]: string } (optional)

Tags applied to the underlying SSM Association created by this resource.

Tags help identify and organize automation executions.