Package software.amazon.awscdk.services.ssmquicksetup

Interface CfnLifecycleAutomationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLifecycleAutomationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:47.724Z")
@Stability(Stable)
public interface CfnLifecycleAutomationProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.ssmquicksetup.*;
 CfnLifecycleAutomationProps cfnLifecycleAutomationProps = CfnLifecycleAutomationProps.builder()
         .automationDocument("automationDocument")
         .automationParameters(Map.of(
                 "automationParametersKey", List.of("automationParameters")))
         .resourceKey("resourceKey")
         // the properties below are optional
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmquicksetup-lifecycleautomation.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnLifecycleAutomationProps.Builder	A builder for CfnLifecycleAutomationProps
static final class	CfnLifecycleAutomationProps.Jsii$Proxy	An implementation for CfnLifecycleAutomationProps

Method Summary

Modifier and Type	Method	Description
static CfnLifecycleAutomationProps.Builder	builder()
String	getAutomationDocument()	The name of the SSM Automation document to execute in response to AWS CloudFormation lifecycle events (CREATE, UPDATE, DELETE).
Object	getAutomationParameters()	A map of key-value parameters passed to the Automation document during execution.
String	getResourceKey()	A unique identifier used for generating the SSM Association name.
default Map<String,String>	getTags()	Tags applied to the underlying SSM Association created by this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAutomationDocument

@Stability(Stable)
@NotNull
String getAutomationDocument()

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

See Also:

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

getAutomationParameters

@Stability(Stable)
@NotNull
Object getAutomationParameters()

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.

Returns union: either IResolvable or Mapinvalid input: '<'String, Listinvalid input: '<'String>>

See Also:

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

getResourceKey

@Stability(Stable)
@NotNull
String getResourceKey()

A unique identifier used for generating the SSM Association name.

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

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

Tags help identify and organize automation executions.

See Also:

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

builder

@Stability(Stable)
static CfnLifecycleAutomationProps.Builder builder()

Returns:

a CfnLifecycleAutomationProps.Builder of CfnLifecycleAutomationProps