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

StartPlanExecutionRequest

class StartPlanExecutionRequest

Types

Builder

class Builder

Companion

object Companion

Properties

action

val action: ExecutionAction?

The action to perform. Valid values are activate (to shift traffic to the target Region) or deactivate (to shift traffic away from the target Region).

comment

val comment: String?

An optional comment explaining why the plan execution is being started.

latestVersion

val latestVersion: String?

A boolean value indicating whether to use the latest version of the plan. If set to false, you must specify a specific version.

mode

val mode: ExecutionMode?

The plan execution mode. Valid values are graceful, for starting the execution in graceful mode, or ungraceful, for starting the execution in ungraceful mode.

planArn

val planArn: String?

The Amazon Resource Name (ARN) of the plan to execute.

recoveryExecutionId

val recoveryExecutionId: String?

The execution identifier of the recovery execution that ran in the opposite region post-recovery is ran in. Required when starting a post-recovery execution.

targetRegion

val targetRegion: String?

The Amazon Web Services Region to target with this execution. This is the Region that traffic will be shifted to or from, depending on the action.

Functions

copy

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

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String