CfnLifecycleAutomationProps

class aws_cdk.aws_ssmquicksetup.CfnLifecycleAutomationProps(*, automation_document, automation_parameters, resource_key, tags=None)

Bases: object

Properties for defining a CfnLifecycleAutomation.

Parameters:

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

  • automation_parameters (Union[IResolvable, Mapping[str, Sequence[str]]]) – 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.

  • resource_key (str) – A unique identifier used for generating the SSM Association name. This ensures uniqueness when multiple lifecycle automation resources exist in the same stack.

  • tags (Optional[Mapping[str, str]]) – Tags applied to the underlying SSM Association created by this resource. Tags help identify and organize automation executions.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ssmquicksetup as ssmquicksetup

cfn_lifecycle_automation_props = ssmquicksetup.CfnLifecycleAutomationProps(
    automation_document="automationDocument",
    automation_parameters={
        "automation_parameters_key": ["automationParameters"]
    },
    resource_key="resourceKey",

    # the properties below are optional
    tags={
        "tags_key": "tags"
    }
)

Attributes

automation_document

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

See:

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

automation_parameters

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.

See:

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

resource_key

A unique identifier used for generating the SSM Association name.

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

tags

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

Tags help identify and organize automation executions.

See:

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