Skip to content

SsmDocumentConfig

Source code in docs_src/capo_arc_region_switch/types/ssm_document_config.py
class SsmDocumentConfig(TypedDict, closed=True):
    cross_account_role: NotRequired[
        "capo_arc_region_switch.types.iam_role_arn.IamRoleArn"
    ]
    """<p>The cross-account role for the configuration.</p>"""
    external_id: NotRequired["str"]
    """<p>The external ID (secret key) for the configuration.</p>"""
    document_arn: "capo_arc_region_switch.types.ssm_document_arn.SsmDocumentArn"
    """<p>The Amazon Resource Name (ARN) of the Systems Manager document to run.</p>"""
    targets: "capo_arc_region_switch.types.ssm_target_list.SsmTargetList"
    """<p>The target filters that Systems Manager resolves to managed nodes when the command runs. To target specific managed nodes, use the <code>InstanceIds</code> key. You can specify up to five target filters.</p>"""
    parameters: NotRequired[
        "capo_arc_region_switch.types.ssm_document_parameters.SsmDocumentParameters"
    ]
    """<p>The parameters that are passed to this Region's Systems Manager document. You set parameters for each document, so each Region can run its document with its own parameters.</p>"""
    document_version: NotRequired[
        "capo_arc_region_switch.types.ssm_document_version.SsmDocumentVersion"
    ]
    """<p>The version of the Systems Manager document to run for this Region. When you omit it, Systems Manager runs the document's default version.</p>"""

cross_account_role instance-attribute

cross_account_role: NotRequired[IamRoleArn]

The cross-account role for the configuration.

document_arn instance-attribute

document_arn: SsmDocumentArn

The Amazon Resource Name (ARN) of the Systems Manager document to run.

document_version instance-attribute

document_version: NotRequired[SsmDocumentVersion]

The version of the Systems Manager document to run for this Region. When you omit it, Systems Manager runs the document's default version.

external_id instance-attribute

external_id: NotRequired[str]

The external ID (secret key) for the configuration.

parameters instance-attribute

parameters: NotRequired[SsmDocumentParameters]

The parameters that are passed to this Region's Systems Manager document. You set parameters for each document, so each Region can run its document with its own parameters.

targets instance-attribute

targets: SsmTargetList

The target filters that Systems Manager resolves to managed nodes when the command runs. To target specific managed nodes, use the InstanceIds key. You can specify up to five target filters.