arcregionswitch/aws.sdk.kotlin.services.arcregionswitch

Package-level declarations

Types

interface ArcRegionSwitchClient : SdkClient

Amazon Application Recovery Controller (ARC) Region switch helps you to quickly and reliably shift traffic away from an impaired Amazon Web Services Region to a healthy Region. With Region switch, you can create plans that define the steps to shift traffic for your application from one Amazon Web Services Region to another. You can test your plans in practice mode before using them in a real recovery scenario.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

approvePlanExecutionStep

inline suspend fun ArcRegionSwitchClient.approvePlanExecutionStep(crossinline block: ApprovePlanExecutionStepRequest.Builder.() -> Unit): ApprovePlanExecutionStepResponse

Approves a step in a plan execution that requires manual approval. When you create a plan, you can include approval steps that require manual intervention before the execution can proceed. This operation allows you to provide that approval.

cancelPlanExecution

inline suspend fun ArcRegionSwitchClient.cancelPlanExecution(crossinline block: CancelPlanExecutionRequest.Builder.() -> Unit): CancelPlanExecutionResponse

Cancels an in-progress plan execution. This operation stops the execution of the plan and prevents any further steps from being processed.

createPlan

inline suspend fun ArcRegionSwitchClient.createPlan(crossinline block: CreatePlanRequest.Builder.() -> Unit): CreatePlanResponse

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

deletePlan

inline suspend fun ArcRegionSwitchClient.deletePlan(crossinline block: DeletePlanRequest.Builder.() -> Unit): DeletePlanResponse

Deletes a Region switch plan. You must specify the ARN of the plan to delete.

getPlan

inline suspend fun ArcRegionSwitchClient.getPlan(crossinline block: GetPlanRequest.Builder.() -> Unit): GetPlanResponse

Retrieves detailed information about a Region switch plan. You must specify the ARN of the plan.

getPlanEvaluationStatus

inline suspend fun ArcRegionSwitchClient.getPlanEvaluationStatus(crossinline block: GetPlanEvaluationStatusRequest.Builder.() -> Unit): GetPlanEvaluationStatusResponse

Retrieves the evaluation status of a Region switch plan. The evaluation status provides information about the last time the plan was evaluated and any warnings or issues detected.

getPlanExecution

inline suspend fun ArcRegionSwitchClient.getPlanExecution(crossinline block: GetPlanExecutionRequest.Builder.() -> Unit): GetPlanExecutionResponse

Retrieves detailed information about a specific plan execution. You must specify the plan ARN and execution ID.

getPlanInRegion

inline suspend fun ArcRegionSwitchClient.getPlanInRegion(crossinline block: GetPlanInRegionRequest.Builder.() -> Unit): GetPlanInRegionResponse

Retrieves information about a Region switch plan in a specific Amazon Web Services Region. This operation is useful for getting Region-specific information about a plan.

listPlanExecutionEvents

inline suspend fun ArcRegionSwitchClient.listPlanExecutionEvents(crossinline block: ListPlanExecutionEventsRequest.Builder.() -> Unit): ListPlanExecutionEventsResponse

Lists the events that occurred during a plan execution. These events provide a detailed timeline of the execution process.

listPlanExecutions

inline suspend fun ArcRegionSwitchClient.listPlanExecutions(crossinline block: ListPlanExecutionsRequest.Builder.() -> Unit): ListPlanExecutionsResponse

Lists the executions of a Region switch plan. This operation returns information about both current and historical executions.

listPlans

inline suspend fun ArcRegionSwitchClient.listPlans(crossinline block: ListPlansRequest.Builder.() -> Unit): ListPlansResponse

Lists all Region switch plans in your Amazon Web Services account.

listPlansInRegion

inline suspend fun ArcRegionSwitchClient.listPlansInRegion(crossinline block: ListPlansInRegionRequest.Builder.() -> Unit): ListPlansInRegionResponse

Lists all Region switch plans in your Amazon Web Services account that are available in the current Amazon Web Services Region.

listRoute53HealthChecks

inline suspend fun ArcRegionSwitchClient.listRoute53HealthChecks(crossinline block: ListRoute53HealthChecksRequest.Builder.() -> Unit): ListRoute53HealthChecksResponse

List the Amazon Route 53 health checks.

listTagsForResource

inline suspend fun ArcRegionSwitchClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists the tags attached to a Region switch resource.

startPlanExecution

inline suspend fun ArcRegionSwitchClient.startPlanExecution(crossinline block: StartPlanExecutionRequest.Builder.() -> Unit): StartPlanExecutionResponse

Starts the execution of a Region switch plan. You can execute a plan in either PRACTICE or RECOVERY mode.

tagResource

inline suspend fun ArcRegionSwitchClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds or updates tags for a Region switch resource. You can assign metadata to your resources in the form of tags, which are key-value pairs.

untagResource

inline suspend fun ArcRegionSwitchClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes tags from a Region switch resource.

updatePlan

inline suspend fun ArcRegionSwitchClient.updatePlan(crossinline block: UpdatePlanRequest.Builder.() -> Unit): UpdatePlanResponse

Updates an existing Region switch plan. You can modify the plan's description, workflows, execution role, recovery time objective, associated alarms, and triggers.

updatePlanExecution

inline suspend fun ArcRegionSwitchClient.updatePlanExecution(crossinline block: UpdatePlanExecutionRequest.Builder.() -> Unit): UpdatePlanExecutionResponse

Updates an in-progress plan execution. This operation allows you to modify certain aspects of the execution, such as adding a comment or changing the action.

updatePlanExecutionStep

inline suspend fun ArcRegionSwitchClient.updatePlanExecutionStep(crossinline block: UpdatePlanExecutionStepRequest.Builder.() -> Unit): UpdatePlanExecutionStepResponse

Updates a specific step in an in-progress plan execution. This operation allows you to modify the step's comment or action.

withConfig

fun ArcRegionSwitchClient.withConfig(block: ArcRegionSwitchClient.Config.Builder.() -> Unit): ArcRegionSwitchClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.