Package software.amazon.awscdk.services.ssmquicksetup

Class CfnLifecycleAutomation.Builder

java.lang.Object

software.amazon.awscdk.services.ssmquicksetup.CfnLifecycleAutomation.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLifecycleAutomation>

Enclosing class:

CfnLifecycleAutomation

@Stability(Stable)
public static final class CfnLifecycleAutomation.Builder
extends Object
implements software.amazon.jsii.Builder<CfnLifecycleAutomation>

A fluent builder for CfnLifecycleAutomation.

Method Summary

Modifier and Type	Method	Description
CfnLifecycleAutomation.Builder	automationDocument(String automationDocument)	The name of the SSM Automation document to execute in response to AWS CloudFormation lifecycle events (CREATE, UPDATE, DELETE).
CfnLifecycleAutomation.Builder	automationParameters(Map<String,? extends List<String>> automationParameters)	A map of key-value parameters passed to the Automation document during execution.
CfnLifecycleAutomation.Builder	automationParameters(IResolvable automationParameters)	A map of key-value parameters passed to the Automation document during execution.
CfnLifecycleAutomation	build()
static CfnLifecycleAutomation.Builder	create(software.constructs.Construct scope, String id)
CfnLifecycleAutomation.Builder	resourceKey(String resourceKey)	A unique identifier used for generating the SSM Association name.
CfnLifecycleAutomation.Builder	tags(Map<String,String> tags)	Tags applied to the underlying SSM Association created by this resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnLifecycleAutomation.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnLifecycleAutomation.Builder.

automationDocument

@Stability(Stable)
public CfnLifecycleAutomation.Builder automationDocument(String automationDocument)

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

Parameters:

automationDocument - The name of the SSM Automation document to execute in response to AWS CloudFormation lifecycle events (CREATE, UPDATE, DELETE). This parameter is required.

Returns:

this

See Also:

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

automationParameters

@Stability(Stable)
public CfnLifecycleAutomation.Builder automationParameters(IResolvable 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.

Parameters:

automationParameters - A map of key-value parameters passed to the Automation document during execution. This parameter is required.

Returns:

this

See Also:

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

automationParameters

@Stability(Stable)
public CfnLifecycleAutomation.Builder automationParameters(Map<String,? extends List<String>> 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.

Parameters:

automationParameters - A map of key-value parameters passed to the Automation document during execution. This parameter is required.

Returns:

this

See Also:

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

resourceKey

@Stability(Stable)
public CfnLifecycleAutomation.Builder resourceKey(String resourceKey)

A unique identifier used for generating the SSM Association name.

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

Parameters:

resourceKey - A unique identifier used for generating the SSM Association name. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnLifecycleAutomation.Builder tags(Map<String,String> tags)

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

Tags help identify and organize automation executions.

Parameters:

tags - Tags applied to the underlying SSM Association created by this resource. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnLifecycleAutomation build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnLifecycleAutomation>

Returns:

a newly built instance of CfnLifecycleAutomation.