Skip to content

SsmDocument

Source code in docs_src/capo_mgn/types/ssm_document.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class SsmDocument(TypedDict, closed=True):
    action_name: "capo_mgn.types.bounded_string.BoundedString"
    """<p>User-friendly name for the AWS Systems Manager Document.</p>"""
    ssm_document_name: "capo_mgn.types.ssm_document_name.SsmDocumentName"
    """<p>AWS Systems Manager Document name or full ARN.</p>"""
    timeout_seconds: NotRequired[
        "capo_mgn.types.strictly_positive_integer.StrictlyPositiveInteger"
    ]
    """<p>AWS Systems Manager Document timeout seconds.</p>"""
    must_succeed_for_cutover: NotRequired["bool"]
    """<p>If true, Cutover will not be enabled if the document has failed.</p>"""
    parameters: NotRequired[
        "capo_mgn.types.ssm_document_parameters.SsmDocumentParameters"
    ]
    """<p>AWS Systems Manager Document parameters.</p>"""
    external_parameters: NotRequired[
        "capo_mgn.types.ssm_document_external_parameters.SsmDocumentExternalParameters"
    ]
    """<p>AWS Systems Manager Document external parameters.</p>"""

action_name instance-attribute 

action_name: BoundedString

User-friendly name for the AWS Systems Manager Document.

external_parameters instance-attribute 

external_parameters: NotRequired[SsmDocumentExternalParameters]

AWS Systems Manager Document external parameters.

must_succeed_for_cutover instance-attribute 

must_succeed_for_cutover: NotRequired[bool]

If true, Cutover will not be enabled if the document has failed.

parameters instance-attribute 

parameters: NotRequired[SsmDocumentParameters]

AWS Systems Manager Document parameters.

ssm_document_name instance-attribute 

ssm_document_name: SsmDocumentName

AWS Systems Manager Document name or full ARN.

timeout_seconds instance-attribute 

timeout_seconds: NotRequired[StrictlyPositiveInteger]

AWS Systems Manager Document timeout seconds.