arczonalshift/aws.sdk.kotlin.services.arczonalshift

Package-level declarations

Types

ArcZonalShiftClient

interface ArcZonalShiftClient : SdkClient

Welcome to the Zonal Shift API Reference Guide for Amazon Route 53 Application Recovery Controller (Route 53 ARC).

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

cancelZonalShift

inline suspend fun ArcZonalShiftClient.cancelZonalShift(crossinline block: CancelZonalShiftRequest.Builder.() -> Unit): CancelZonalShiftResponse

Cancel a zonal shift in Amazon Route 53 Application Recovery Controller. To cancel the zonal shift, specify the zonal shift ID.

createPracticeRunConfiguration

inline suspend fun ArcZonalShiftClient.createPracticeRunConfiguration(crossinline block: CreatePracticeRunConfigurationRequest.Builder.() -> Unit): CreatePracticeRunConfigurationResponse

A practice run configuration for zonal autoshift is required when you enable zonal autoshift. A practice run configuration includes specifications for blocked dates and blocked time windows, and for Amazon CloudWatch alarms that you create to use with practice runs. The alarms that you specify are an outcome alarm, to monitor application health during practice runs and, optionally, a blocking alarm, to block practice runs from starting.

deletePracticeRunConfiguration

inline suspend fun ArcZonalShiftClient.deletePracticeRunConfiguration(crossinline block: DeletePracticeRunConfigurationRequest.Builder.() -> Unit): DeletePracticeRunConfigurationResponse

Deletes the practice run configuration for a resource. Before you can delete a practice run configuration for a resource., you must disable zonal autoshift for the resource. Practice runs must be configured for zonal autoshift to be enabled.

getManagedResource

inline suspend fun ArcZonalShiftClient.getManagedResource(crossinline block: GetManagedResourceRequest.Builder.() -> Unit): GetManagedResourceResponse

Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this Amazon Web Services Region. Resources that are registered for zonal shifts are managed resources in Route 53 ARC. You can start zonal shifts and configure zonal autoshift for managed resources.

listAutoshifts

inline suspend fun ArcZonalShiftClient.listAutoshifts(crossinline block: ListAutoshiftsRequest.Builder.() -> Unit): ListAutoshiftsResponse

Returns the active autoshifts for a specified resource.

listManagedResources

inline suspend fun ArcZonalShiftClient.listManagedResources(crossinline block: ListManagedResourcesRequest.Builder.() -> Unit): ListManagedResourcesResponse

Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them. The information includes the zonal autoshift status for the resource, as well as the Amazon Resource Name (ARN), the Availability Zones that each resource is deployed in, and the resource name.

listZonalShifts

inline suspend fun ArcZonalShiftClient.listZonalShifts(crossinline block: ListZonalShiftsRequest.Builder.() -> Unit): ListZonalShiftsResponse

Lists all active and completed zonal shifts in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region. ListZonalShifts returns customer-started zonal shifts, as well as practice run zonal shifts that Route 53 ARC started on your behalf for zonal autoshift.

startZonalShift

inline suspend fun ArcZonalShiftClient.startZonalShift(crossinline block: StartZonalShiftRequest.Builder.() -> Unit): StartZonalShiftResponse

You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in an Amazon Web Services Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone. You can start a zonal shift in Route 53 ARC only for managed resources in your Amazon Web Services account in an Amazon Web Services Region. Resources are automatically registered with Route 53 ARC by Amazon Web Services services.

updatePracticeRunConfiguration

inline suspend fun ArcZonalShiftClient.updatePracticeRunConfiguration(crossinline block: UpdatePracticeRunConfigurationRequest.Builder.() -> Unit): UpdatePracticeRunConfigurationResponse

Update a practice run configuration to change one or more of the following: add, change, or remove the blocking alarm; change the outcome alarm; or add, change, or remove blocking dates or time windows.

updateZonalAutoshiftConfiguration

inline suspend fun ArcZonalShiftClient.updateZonalAutoshiftConfiguration(crossinline block: UpdateZonalAutoshiftConfigurationRequest.Builder.() -> Unit): UpdateZonalAutoshiftConfigurationResponse

You can update the zonal autoshift status for a resource, to enable or disable zonal autoshift. When zonal autoshift is ENABLED, Amazon Web Services shifts away resource traffic from an Availability Zone, on your behalf, when Amazon Web Services determines that there's an issue in the Availability Zone that could potentially affect customers.

updateZonalShift

inline suspend fun ArcZonalShiftClient.updateZonalShift(crossinline block: UpdateZonalShiftRequest.Builder.() -> Unit): UpdateZonalShiftResponse

Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account. You can update a zonal shift to set a new expiration, or edit or replace the comment for the zonal shift.

withConfig

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

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.