Skip to content

TemplateActionDocument

Source code in docs_src/capo_mgn/types/template_action_document.py
class TemplateActionDocument(TypedDict, closed=True):
    action_id: NotRequired["capo_mgn.types.action_id.ActionID"]
    """<p>Template post migration custom action ID.</p>"""
    action_name: NotRequired["capo_mgn.types.bounded_string.BoundedString"]
    """<p>Template post migration custom action name.</p>"""
    document_identifier: NotRequired["capo_mgn.types.bounded_string.BoundedString"]
    """<p>Template post migration custom action document identifier.</p>"""
    order: NotRequired["capo_mgn.types.order_type.OrderType"]
    """<p>Template post migration custom action order.</p>"""
    document_version: NotRequired["capo_mgn.types.document_version.DocumentVersion"]
    """<p>Template post migration custom action document version.</p>"""
    active: NotRequired["bool"]
    """<p>Template post migration custom action active status.</p>"""
    timeout_seconds: NotRequired[
        "capo_mgn.types.strictly_positive_integer.StrictlyPositiveInteger"
    ]
    """<p>Template post migration custom action timeout in seconds.</p>"""
    must_succeed_for_cutover: NotRequired["bool"]
    """<p>Template post migration custom action must succeed for cutover.</p>"""
    parameters: NotRequired[
        "capo_mgn.types.ssm_document_parameters.SsmDocumentParameters"
    ]
    """<p>Template post migration custom action parameters.</p>"""
    operating_system: NotRequired[
        "capo_mgn.types.operating_system_string.OperatingSystemString"
    ]
    """<p>Operating system eligible for this template post migration custom action.</p>"""
    external_parameters: NotRequired[
        "capo_mgn.types.ssm_document_external_parameters.SsmDocumentExternalParameters"
    ]
    """<p>Template post migration custom action external parameters.</p>"""
    description: NotRequired["capo_mgn.types.action_description.ActionDescription"]
    """<p>Template post migration custom action description.</p>"""
    category: NotRequired["capo_mgn.types.action_category.ActionCategory"]
    """<p>Template post migration custom action category.</p>"""

action_id instance-attribute

action_id: NotRequired[ActionID]

Template post migration custom action ID.

action_name instance-attribute

action_name: NotRequired[BoundedString]

Template post migration custom action name.

active instance-attribute

active: NotRequired[bool]

Template post migration custom action active status.

category instance-attribute

category: NotRequired[ActionCategory]

Template post migration custom action category.

description instance-attribute

description: NotRequired[ActionDescription]

Template post migration custom action description.

document_identifier instance-attribute

document_identifier: NotRequired[BoundedString]

Template post migration custom action document identifier.

document_version instance-attribute

document_version: NotRequired[DocumentVersion]

Template post migration custom action document version.

external_parameters instance-attribute

external_parameters: NotRequired[SsmDocumentExternalParameters]

Template post migration custom action external parameters.

must_succeed_for_cutover instance-attribute

must_succeed_for_cutover: NotRequired[bool]

Template post migration custom action must succeed for cutover.

operating_system instance-attribute

operating_system: NotRequired[OperatingSystemString]

Operating system eligible for this template post migration custom action.

order instance-attribute

order: NotRequired[OrderType]

Template post migration custom action order.

parameters instance-attribute

parameters: NotRequired[SsmDocumentParameters]

Template post migration custom action parameters.

timeout_seconds instance-attribute

timeout_seconds: NotRequired[StrictlyPositiveInteger]

Template post migration custom action timeout in seconds.