arcregionswitch/aws.sdk.kotlin.services.arcregionswitch.model/Plan

Plan

class Plan

Represents a Region switch plan. A plan defines the steps required to shift traffic from one Amazon Web Services Region to another.

Types

object Companion

Properties

val arn: String

The Amazon Resource Name (ARN) of the plan.

associatedAlarms

val associatedAlarms: Map<String, AssociatedAlarm>?

The associated application health alarms for a plan.

val description: String?

The description for a plan.

val executionRole: String

The execution role for a plan.

val name: String

The name for a plan.

val owner: String

The owner of a plan.

val primaryRegion: String?

The primary Region for a plan.

recoveryApproach

val recoveryApproach: RecoveryApproach

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

recoveryTimeObjectiveMinutes

val recoveryTimeObjectiveMinutes: Int?

The recovery time objective for a plan.

val regions: List<String>

The Amazon Web Services Regions for a plan.

reportConfiguration

val reportConfiguration: ReportConfiguration?

The report configuration for a plan.

serviceQuotaChecksEnabled

val serviceQuotaChecksEnabled: Boolean?

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.

val triggers: List<Trigger>?

The triggers for a plan.

val updatedAt: Instant?

The timestamp when the plan was last updated.

val version: String?

The version for the plan.

val workflows: List<Workflow>

The workflows for a plan.

Functions

inline fun copy(block: Plan.Builder.() -> Unit = {}): Plan

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String