Skip to content

Plan

Source code in docs_src/capo_arc_region_switch/types/plan.py
class Plan(TypedDict, closed=True):
    arn: "capo_arc_region_switch.types.plan_arn.PlanArn"
    """<p>The Amazon Resource Name (ARN) of the plan.</p>"""
    description: NotRequired["str"]
    """<p>The description for a plan.</p>"""
    workflows: "capo_arc_region_switch.types.workflow_list.WorkflowList"
    """<p>The workflows for a plan.</p>"""
    execution_role: "capo_arc_region_switch.types.iam_role_arn.IamRoleArn"
    """<p>The execution role for a plan.</p>"""
    recovery_time_objective_minutes: NotRequired["int"]
    """<p>The recovery time objective for a plan.</p>"""
    associated_alarms: NotRequired[
        "capo_arc_region_switch.types.associated_alarm_map.AssociatedAlarmMap"
    ]
    """<p>The associated application health alarms for a plan.</p>"""
    triggers: NotRequired["capo_arc_region_switch.types.trigger_list.TriggerList"]
    """<p>The triggers for a plan.</p>"""
    report_configuration: NotRequired[
        "capo_arc_region_switch.types.report_configuration.ReportConfiguration"
    ]
    """<p>The report configuration for a plan.</p>"""
    service_quota_checks_enabled: NotRequired["bool"]
    """<p>Indicates whether service quota checks are enabled for the Region switch plan. When enabled, Region switch compares the applied service quota values across the plan's Amazon Web Services Regions and creates a warning when a quota in one Region is lower than the value required for the matching resource in another Region. Service quota checks are advisory and don't prevent you from creating, evaluating, or executing a plan.</p>"""
    name: "capo_arc_region_switch.types.plan_name.PlanName"
    """<p>The name for a plan.</p>"""
    regions: "capo_arc_region_switch.types.region_list.RegionList"
    """<p>The Amazon Web Services Regions for a plan.</p>"""
    recovery_approach: "capo_arc_region_switch.types.recovery_approach.RecoveryApproach"
    """<p>The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).</p>"""
    primary_region: NotRequired["capo_arc_region_switch.types.region.Region"]
    """<p>The primary Region for a plan.</p>"""
    owner: "capo_arc_region_switch.types.account_id.AccountId"
    """<p>The owner of a plan.</p>"""
    version: NotRequired["str"]
    """<p>The version for the plan.</p>"""
    updated_at: NotRequired["datetime.datetime"]
    """<p>The timestamp when the plan was last updated.</p>"""

arn instance-attribute

arn: PlanArn

The Amazon Resource Name (ARN) of the plan.

associated_alarms instance-attribute

associated_alarms: NotRequired[AssociatedAlarmMap]

The associated application health alarms for a plan.

description instance-attribute

description: NotRequired[str]

The description for a plan.

execution_role instance-attribute

execution_role: IamRoleArn

The execution role for a plan.

name instance-attribute

name: PlanName

The name for a plan.

owner instance-attribute

owner: AccountId

The owner of a plan.

primary_region instance-attribute

primary_region: NotRequired[Region]

The primary Region for a plan.

recovery_approach instance-attribute

recovery_approach: RecoveryApproach

The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).

recovery_time_objective_minutes instance-attribute

recovery_time_objective_minutes: NotRequired[int]

The recovery time objective for a plan.

regions instance-attribute

regions: RegionList

The Amazon Web Services Regions for a plan.

report_configuration instance-attribute

report_configuration: NotRequired[ReportConfiguration]

The report configuration for a plan.

service_quota_checks_enabled instance-attribute

service_quota_checks_enabled: NotRequired[bool]

Indicates whether service quota checks are enabled for the Region switch plan. When enabled, Region switch compares the applied service quota values across the plan's Amazon Web Services Regions and creates a warning when a quota in one Region is lower than the value required for the matching resource in another Region. Service quota checks are advisory and don't prevent you from creating, evaluating, or executing a plan.

triggers instance-attribute

triggers: NotRequired[TriggerList]

The triggers for a plan.

updated_at instance-attribute

updated_at: NotRequired[datetime]

The timestamp when the plan was last updated.

version instance-attribute

version: NotRequired[str]

The version for the plan.

workflows instance-attribute

workflows: WorkflowList

The workflows for a plan.