route53recoverycontrolconfig/aws.sdk.kotlin.services.route53recoverycontrolconfig/Route53RecoveryControlConfigClient

Route53RecoveryControlConfigClient

interface Route53RecoveryControlConfigClient : SdkClient

Recovery Control Configuration API Reference for Amazon Route 53 Application Recovery Controller

Types

class Builder : AbstractSdkClientBuilder<Route53RecoveryControlConfigClient.Config, Route53RecoveryControlConfigClient.Config.Builder, Route53RecoveryControlConfigClient>

Companion

object Companion : AbstractAwsSdkClientFactory<Route53RecoveryControlConfigClient.Config, Route53RecoveryControlConfigClient.Config.Builder, Route53RecoveryControlConfigClient, Route53RecoveryControlConfigClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: Route53RecoveryControlConfigClient.Config

Route53RecoveryControlConfigClient's configuration

Functions

createCluster

abstract suspend fun createCluster(input: CreateClusterRequest): CreateClusterResponse

Create a new cluster. A cluster is a set of redundant Regional endpoints against which you can run API calls to update or get the state of one or more routing controls. Each cluster has a name, status, Amazon Resource Name (ARN), and an array of the five cluster endpoints (one for each supported Amazon Web Services Region) that you can use with API calls to the cluster data plane.

createControlPanel

abstract suspend fun createControlPanel(input: CreateControlPanelRequest): CreateControlPanelResponse

Creates a new control panel. A control panel represents a group of routing controls that can be changed together in a single transaction. You can use a control panel to centrally view the operational status of applications across your organization, and trigger multi-app failovers in a single transaction, for example, to fail over an Availability Zone or Amazon Web Services Region.

createRoutingControl

abstract suspend fun createRoutingControl(input: CreateRoutingControlRequest): CreateRoutingControlResponse

Creates a new routing control.

createSafetyRule

abstract suspend fun createSafetyRule(input: CreateSafetyRuleRequest = CreateSafetyRuleRequest { }): CreateSafetyRuleResponse

Creates a safety rule in a control panel. Safety rules let you add safeguards around changing routing control states, and for enabling and disabling routing controls, to help prevent unexpected outcomes.

deleteCluster

abstract suspend fun deleteCluster(input: DeleteClusterRequest): DeleteClusterResponse

Delete a cluster.

deleteControlPanel

abstract suspend fun deleteControlPanel(input: DeleteControlPanelRequest): DeleteControlPanelResponse

Deletes a control panel.

deleteRoutingControl

abstract suspend fun deleteRoutingControl(input: DeleteRoutingControlRequest): DeleteRoutingControlResponse

Deletes a routing control.

deleteSafetyRule

abstract suspend fun deleteSafetyRule(input: DeleteSafetyRuleRequest): DeleteSafetyRuleResponse

Deletes a safety rule.

describeCluster

abstract suspend fun describeCluster(input: DescribeClusterRequest): DescribeClusterResponse

Display the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name (ARN).

describeControlPanel

abstract suspend fun describeControlPanel(input: DescribeControlPanelRequest): DescribeControlPanelResponse

Displays details about a control panel.

describeRoutingControl

abstract suspend fun describeRoutingControl(input: DescribeRoutingControlRequest): DescribeRoutingControlResponse

Displays details about a routing control. A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing.

describeSafetyRule

abstract suspend fun describeSafetyRule(input: DescribeSafetyRuleRequest): DescribeSafetyRuleResponse

Returns information about a safety rule.

getResourcePolicy

abstract suspend fun getResourcePolicy(input: GetResourcePolicyRequest): GetResourcePolicyResponse

Get information about the resource policy for a cluster.

listAssociatedRoute53HealthChecks

abstract suspend fun listAssociatedRoute53HealthChecks(input: ListAssociatedRoute53HealthChecksRequest): ListAssociatedRoute53HealthChecksResponse

Returns an array of all Amazon Route 53 health checks associated with a specific routing control.

listClusters

abstract suspend fun listClusters(input: ListClustersRequest = ListClustersRequest { }): ListClustersResponse

Returns an array of all the clusters in an account.

listControlPanels

abstract suspend fun listControlPanels(input: ListControlPanelsRequest = ListControlPanelsRequest { }): ListControlPanelsResponse

Returns an array of control panels in an account or in a cluster.

listRoutingControls

abstract suspend fun listRoutingControls(input: ListRoutingControlsRequest): ListRoutingControlsResponse

Returns an array of routing controls for a control panel. A routing control is an Amazon Route 53 Application Recovery Controller construct that has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing.

listSafetyRules

abstract suspend fun listSafetyRules(input: ListSafetyRulesRequest): ListSafetyRulesResponse

List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists the tags for a resource.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds a tag to a resource.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes a tag from a resource.

updateControlPanel

abstract suspend fun updateControlPanel(input: UpdateControlPanelRequest): UpdateControlPanelResponse

Updates a control panel. The only update you can make to a control panel is to change the name of the control panel.

updateRoutingControl

abstract suspend fun updateRoutingControl(input: UpdateRoutingControlRequest): UpdateRoutingControlResponse

Updates a routing control. You can only update the name of the routing control. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.

updateSafetyRule

abstract suspend fun updateSafetyRule(input: UpdateSafetyRuleRequest = UpdateSafetyRuleRequest { }): UpdateSafetyRuleResponse

Update a safety rule (an assertion rule or gating rule). You can only update the name and the waiting period for a safety rule. To make other updates, delete the safety rule and create a new one.

Inherited functions

expect abstract fun close()

createCluster

inline suspend fun Route53RecoveryControlConfigClient.createCluster(crossinline block: CreateClusterRequest.Builder.() -> Unit): CreateClusterResponse

createControlPanel

inline suspend fun Route53RecoveryControlConfigClient.createControlPanel(crossinline block: CreateControlPanelRequest.Builder.() -> Unit): CreateControlPanelResponse

createRoutingControl

inline suspend fun Route53RecoveryControlConfigClient.createRoutingControl(crossinline block: CreateRoutingControlRequest.Builder.() -> Unit): CreateRoutingControlResponse

Creates a new routing control.

createSafetyRule

inline suspend fun Route53RecoveryControlConfigClient.createSafetyRule(crossinline block: CreateSafetyRuleRequest.Builder.() -> Unit): CreateSafetyRuleResponse

deleteCluster

inline suspend fun Route53RecoveryControlConfigClient.deleteCluster(crossinline block: DeleteClusterRequest.Builder.() -> Unit): DeleteClusterResponse

Delete a cluster.

deleteControlPanel

inline suspend fun Route53RecoveryControlConfigClient.deleteControlPanel(crossinline block: DeleteControlPanelRequest.Builder.() -> Unit): DeleteControlPanelResponse

Deletes a control panel.

deleteRoutingControl

inline suspend fun Route53RecoveryControlConfigClient.deleteRoutingControl(crossinline block: DeleteRoutingControlRequest.Builder.() -> Unit): DeleteRoutingControlResponse

Deletes a routing control.

deleteSafetyRule

inline suspend fun Route53RecoveryControlConfigClient.deleteSafetyRule(crossinline block: DeleteSafetyRuleRequest.Builder.() -> Unit): DeleteSafetyRuleResponse

Deletes a safety rule.

describeCluster

inline suspend fun Route53RecoveryControlConfigClient.describeCluster(crossinline block: DescribeClusterRequest.Builder.() -> Unit): DescribeClusterResponse

Display the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name (ARN).

describeControlPanel

inline suspend fun Route53RecoveryControlConfigClient.describeControlPanel(crossinline block: DescribeControlPanelRequest.Builder.() -> Unit): DescribeControlPanelResponse

Displays details about a control panel.

describeRoutingControl

inline suspend fun Route53RecoveryControlConfigClient.describeRoutingControl(crossinline block: DescribeRoutingControlRequest.Builder.() -> Unit): DescribeRoutingControlResponse

describeSafetyRule

inline suspend fun Route53RecoveryControlConfigClient.describeSafetyRule(crossinline block: DescribeSafetyRuleRequest.Builder.() -> Unit): DescribeSafetyRuleResponse

Returns information about a safety rule.

getResourcePolicy

inline suspend fun Route53RecoveryControlConfigClient.getResourcePolicy(crossinline block: GetResourcePolicyRequest.Builder.() -> Unit): GetResourcePolicyResponse

Get information about the resource policy for a cluster.

listAssociatedRoute53HealthChecks

inline suspend fun Route53RecoveryControlConfigClient.listAssociatedRoute53HealthChecks(crossinline block: ListAssociatedRoute53HealthChecksRequest.Builder.() -> Unit): ListAssociatedRoute53HealthChecksResponse

Returns an array of all Amazon Route 53 health checks associated with a specific routing control.

listAssociatedRoute53HealthChecksPaginated

fun Route53RecoveryControlConfigClient.listAssociatedRoute53HealthChecksPaginated(initialRequest: ListAssociatedRoute53HealthChecksRequest): Flow<ListAssociatedRoute53HealthChecksResponse>

fun Route53RecoveryControlConfigClient.listAssociatedRoute53HealthChecksPaginated(block: ListAssociatedRoute53HealthChecksRequest.Builder.() -> Unit): Flow<ListAssociatedRoute53HealthChecksResponse>

Paginate over ListAssociatedRoute53HealthChecksResponse results.

listClusters

inline suspend fun Route53RecoveryControlConfigClient.listClusters(crossinline block: ListClustersRequest.Builder.() -> Unit): ListClustersResponse

Returns an array of all the clusters in an account.

listClustersPaginated

fun Route53RecoveryControlConfigClient.listClustersPaginated(initialRequest: ListClustersRequest = ListClustersRequest { }): Flow<ListClustersResponse>

fun Route53RecoveryControlConfigClient.listClustersPaginated(block: ListClustersRequest.Builder.() -> Unit): Flow<ListClustersResponse>

Paginate over ListClustersResponse results.

listControlPanels

inline suspend fun Route53RecoveryControlConfigClient.listControlPanels(crossinline block: ListControlPanelsRequest.Builder.() -> Unit): ListControlPanelsResponse

Returns an array of control panels in an account or in a cluster.

listControlPanelsPaginated

fun Route53RecoveryControlConfigClient.listControlPanelsPaginated(initialRequest: ListControlPanelsRequest = ListControlPanelsRequest { }): Flow<ListControlPanelsResponse>

fun Route53RecoveryControlConfigClient.listControlPanelsPaginated(block: ListControlPanelsRequest.Builder.() -> Unit): Flow<ListControlPanelsResponse>

Paginate over ListControlPanelsResponse results.

listRoutingControls

inline suspend fun Route53RecoveryControlConfigClient.listRoutingControls(crossinline block: ListRoutingControlsRequest.Builder.() -> Unit): ListRoutingControlsResponse

listRoutingControlsPaginated

fun Route53RecoveryControlConfigClient.listRoutingControlsPaginated(initialRequest: ListRoutingControlsRequest): Flow<ListRoutingControlsResponse>

fun Route53RecoveryControlConfigClient.listRoutingControlsPaginated(block: ListRoutingControlsRequest.Builder.() -> Unit): Flow<ListRoutingControlsResponse>

Paginate over ListRoutingControlsResponse results.

listSafetyRules

inline suspend fun Route53RecoveryControlConfigClient.listSafetyRules(crossinline block: ListSafetyRulesRequest.Builder.() -> Unit): ListSafetyRulesResponse

List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.

listSafetyRulesPaginated

fun Route53RecoveryControlConfigClient.listSafetyRulesPaginated(initialRequest: ListSafetyRulesRequest): Flow<ListSafetyRulesResponse>

fun Route53RecoveryControlConfigClient.listSafetyRulesPaginated(block: ListSafetyRulesRequest.Builder.() -> Unit): Flow<ListSafetyRulesResponse>

Paginate over ListSafetyRulesResponse results.

listTagsForResource

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

Lists the tags for a resource.

tagResource

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

Adds a tag to a resource.

untagResource

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

Removes a tag from a resource.

updateControlPanel

inline suspend fun Route53RecoveryControlConfigClient.updateControlPanel(crossinline block: UpdateControlPanelRequest.Builder.() -> Unit): UpdateControlPanelResponse

Updates a control panel. The only update you can make to a control panel is to change the name of the control panel.

updateRoutingControl

inline suspend fun Route53RecoveryControlConfigClient.updateRoutingControl(crossinline block: UpdateRoutingControlRequest.Builder.() -> Unit): UpdateRoutingControlResponse

updateSafetyRule

inline suspend fun Route53RecoveryControlConfigClient.updateSafetyRule(crossinline block: UpdateSafetyRuleRequest.Builder.() -> Unit): UpdateSafetyRuleResponse

Update a safety rule (an assertion rule or gating rule). You can only update the name and the waiting period for a safety rule. To make other updates, delete the safety rule and create a new one.

waitUntilClusterCreated

suspend fun Route53RecoveryControlConfigClient.waitUntilClusterCreated(request: DescribeClusterRequest): Outcome<DescribeClusterResponse>

suspend fun Route53RecoveryControlConfigClient.waitUntilClusterCreated(block: DescribeClusterRequest.Builder.() -> Unit): Outcome<DescribeClusterResponse>

Wait until a cluster is created

waitUntilClusterDeleted

suspend fun Route53RecoveryControlConfigClient.waitUntilClusterDeleted(request: DescribeClusterRequest): Outcome<DescribeClusterResponse>

suspend fun Route53RecoveryControlConfigClient.waitUntilClusterDeleted(block: DescribeClusterRequest.Builder.() -> Unit): Outcome<DescribeClusterResponse>

Wait for a cluster to be deleted

waitUntilControlPanelCreated

suspend fun Route53RecoveryControlConfigClient.waitUntilControlPanelCreated(request: DescribeControlPanelRequest): Outcome<DescribeControlPanelResponse>

suspend fun Route53RecoveryControlConfigClient.waitUntilControlPanelCreated(block: DescribeControlPanelRequest.Builder.() -> Unit): Outcome<DescribeControlPanelResponse>

Wait until a control panel is created

waitUntilControlPanelDeleted

suspend fun Route53RecoveryControlConfigClient.waitUntilControlPanelDeleted(request: DescribeControlPanelRequest): Outcome<DescribeControlPanelResponse>

suspend fun Route53RecoveryControlConfigClient.waitUntilControlPanelDeleted(block: DescribeControlPanelRequest.Builder.() -> Unit): Outcome<DescribeControlPanelResponse>

Wait until a control panel is deleted

waitUntilRoutingControlCreated

suspend fun Route53RecoveryControlConfigClient.waitUntilRoutingControlCreated(request: DescribeRoutingControlRequest): Outcome<DescribeRoutingControlResponse>

suspend fun Route53RecoveryControlConfigClient.waitUntilRoutingControlCreated(block: DescribeRoutingControlRequest.Builder.() -> Unit): Outcome<DescribeRoutingControlResponse>

Wait until a routing control is created

waitUntilRoutingControlDeleted

suspend fun Route53RecoveryControlConfigClient.waitUntilRoutingControlDeleted(request: DescribeRoutingControlRequest): Outcome<DescribeRoutingControlResponse>

suspend fun Route53RecoveryControlConfigClient.waitUntilRoutingControlDeleted(block: DescribeRoutingControlRequest.Builder.() -> Unit): Outcome<DescribeRoutingControlResponse>

Wait for a routing control to be deleted

withConfig

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

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.