Skip to content

CreatePlanRequest

Source code in docs_src/capo_arc_region_switch/types/create_plan_request.py
class CreatePlanRequest(TypedDict, closed=True):
    description: NotRequired["str"]
    """<p>The description of a Region switch plan.</p>"""
    workflows: "capo_arc_region_switch.types.workflow_list.WorkflowList"
    """<p>An array of workflows included in a Region switch plan.</p>"""
    execution_role: "capo_arc_region_switch.types.iam_role_arn.IamRoleArn"
    """<p>An execution role is a way to categorize a Region switch plan.</p>"""
    recovery_time_objective_minutes: NotRequired["int"]
    """<p>Optionally, you can specify an recovery time objective for a Region switch plan, in minutes.</p>"""
    associated_alarms: NotRequired[
        "capo_arc_region_switch.types.associated_alarm_map.AssociatedAlarmMap"
    ]
    """<p>The alarms associated with a Region switch plan.</p>"""
    triggers: NotRequired["capo_arc_region_switch.types.trigger_list.TriggerList"]
    """<p>The triggers associated with a Region switch plan.</p>"""
    report_configuration: NotRequired[
        "capo_arc_region_switch.types.report_configuration.ReportConfiguration"
    ]
    service_quota_checks_enabled: NotRequired["bool"]
    """<p>Specifies whether to enable service quota checks for the Region switch plan.</p>"""
    name: "capo_arc_region_switch.types.plan_name.PlanName"
    """<p>The name of a Region switch plan.</p>"""
    regions: "capo_arc_region_switch.types.region_list.RegionList"
    """<p>An array that specifies the Amazon Web Services Regions for a Region switch plan. Specify two Regions.</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 Amazon Web Services Region for the application. This is the Region where the application normally runs before any Region switch occurs.</p>"""
    tags: NotRequired["capo_arc_region_switch.types.tags.Tags"]
    """<p>The tags to apply to the Region switch plan.</p>"""

associated_alarms instance-attribute

associated_alarms: NotRequired[AssociatedAlarmMap]

The alarms associated with a Region switch plan.

description instance-attribute

description: NotRequired[str]

The description of a Region switch plan.

execution_role instance-attribute

execution_role: IamRoleArn

An execution role is a way to categorize a Region switch plan.

name instance-attribute

name: PlanName

The name of a Region switch plan.

primary_region instance-attribute

primary_region: NotRequired[Region]

The primary Amazon Web Services Region for the application. This is the Region where the application normally runs before any Region switch occurs.

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]

Optionally, you can specify an recovery time objective for a Region switch plan, in minutes.

regions instance-attribute

regions: RegionList

An array that specifies the Amazon Web Services Regions for a Region switch plan. Specify two Regions.

report_configuration instance-attribute

report_configuration: NotRequired[ReportConfiguration]

service_quota_checks_enabled instance-attribute

service_quota_checks_enabled: NotRequired[bool]

Specifies whether to enable service quota checks for the Region switch plan.

tags instance-attribute

tags: NotRequired[Tags]

The tags to apply to the Region switch plan.

triggers instance-attribute

triggers: NotRequired[TriggerList]

The triggers associated with a Region switch plan.

workflows instance-attribute

workflows: WorkflowList

An array of workflows included in a Region switch plan.