Skip to content

SsmAutomation

Source code in docs_src/capo_ssm_incidents/types/ssm_automation.py
class SsmAutomation(TypedDict, closed=True):
    role_arn: "capo_ssm_incidents.types.role_arn.RoleArn"
    """<p>The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.</p>"""
    document_name: "str"
    """<p>The automation document's name.</p>"""
    document_version: NotRequired["str"]
    """<p>The automation document's version to use when running.</p>"""
    target_account: NotRequired[
        "capo_ssm_incidents.types.ssm_target_account.SsmTargetAccount"
    ]
    """<p>The account that the automation document will be run in. This can be in either the management account or an application account.</p>"""
    parameters: NotRequired["capo_ssm_incidents.types.ssm_parameters.SsmParameters"]
    """<p>The key-value pair parameters to use when running the automation document.</p>"""
    dynamic_parameters: NotRequired[
        "capo_ssm_incidents.types.dynamic_ssm_parameters.DynamicSsmParameters"
    ]
    """<p>The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.</p>"""

document_name instance-attribute

document_name: str

The automation document's name.

document_version instance-attribute

document_version: NotRequired[str]

The automation document's version to use when running.

dynamic_parameters instance-attribute

dynamic_parameters: NotRequired[DynamicSsmParameters]

The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.

parameters instance-attribute

parameters: NotRequired[SsmParameters]

The key-value pair parameters to use when running the automation document.

role_arn instance-attribute

role_arn: RoleArn

The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.

target_account instance-attribute

target_account: NotRequired[SsmTargetAccount]

The account that the automation document will be run in. This can be in either the management account or an application account.