| 1 |
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. |
| 2 |
|
| 3 |
// Package route53recoverycluster provides the client and types for making API |
| 4 |
// requests to Route53 Recovery Cluster. |
| 5 |
// |
| 6 |
// Welcome to the Routing Control (Recovery Cluster) API Reference Guide for |
| 7 |
// Amazon Route 53 Application Recovery Controller. |
| 8 |
// |
| 9 |
// With Route 53 ARC, you can use routing control with extreme reliability to |
| 10 |
// recover applications by rerouting traffic across Availability Zones or Amazon |
| 11 |
// Web Services Regions. Routing controls are simple on/off switches hosted |
| 12 |
// on a highly available cluster in Route 53 ARC. A cluster provides a set of |
| 13 |
// five redundant Regional endpoints against which you can run API calls to |
| 14 |
// get or update the state of routing controls. To implement failover, you set |
| 15 |
// one routing control to ON and another one to OFF, to reroute traffic from |
| 16 |
// one Availability Zone or Amazon Web Services Region to another. |
| 17 |
// |
| 18 |
// Be aware that you must specify a Regional endpoint for a cluster when you |
| 19 |
// work with API cluster operations to get or update routing control states |
| 20 |
// in Route 53 ARC. In addition, you must specify the US West (Oregon) Region |
| 21 |
// for Route 53 ARC API calls. For example, use the parameter --region us-west-2 |
| 22 |
// with AWS CLI commands. For more information, see Get and update routing control |
| 23 |
// states using the API (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.api.html) |
| 24 |
// in the Amazon Route 53 Application Recovery Controller Developer Guide. |
| 25 |
// |
| 26 |
// This API guide includes information about the API operations for how to get |
| 27 |
// and update routing control states in Route 53 ARC. To work with routing control |
| 28 |
// in Route 53 ARC, you must first create the required components (clusters, |
| 29 |
// control panels, and routing controls) using the recovery cluster configuration |
| 30 |
// API. |
| 31 |
// |
| 32 |
// For more information about working with routing control in Route 53 ARC, |
| 33 |
// see the following: |
| 34 |
// |
| 35 |
// - Create clusters, control panels, and routing controls by using API operations. |
| 36 |
// For more information, see the Recovery Control Configuration API Reference |
| 37 |
// Guide for Amazon Route 53 Application Recovery Controller (https://docs.aws.amazon.com/recovery-cluster/latest/api/). |
| 38 |
// |
| 39 |
// - Learn about the components in recovery control, including clusters, |
| 40 |
// routing controls, and control panels, and how to work with Route 53 ARC |
| 41 |
// in the Amazon Web Services console. For more information, see Recovery |
| 42 |
// control components (https://docs.aws.amazon.com/r53recovery/latest/dg/introduction-components.html#introduction-components-routing) |
| 43 |
// in the Amazon Route 53 Application Recovery Controller Developer Guide. |
| 44 |
// |
| 45 |
// - Route 53 ARC also provides readiness checks that continually audit resources |
| 46 |
// to help make sure that your applications are scaled and ready to handle |
| 47 |
// failover traffic. For more information about the related API operations, |
| 48 |
// see the Recovery Readiness API Reference Guide for Amazon Route 53 Application |
| 49 |
// Recovery Controller (https://docs.aws.amazon.com/recovery-readiness/latest/api/). |
| 50 |
// |
| 51 |
// - For more information about creating resilient applications and preparing |
| 52 |
// for recovery readiness with Route 53 ARC, see the Amazon Route 53 Application |
| 53 |
// Recovery Controller Developer Guide (https://docs.aws.amazon.com/r53recovery/latest/dg/). |
| 54 |
// |
| 55 |
// See https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-cluster-2019-12-02 for more information on this service. |
| 56 |
// |
| 57 |
// See route53recoverycluster package documentation for more information. |
| 58 |
// https://docs.aws.amazon.com/sdk-for-go/api/service/route53recoverycluster/ |
| 59 |
// |
| 60 |
// # Using the Client |
| 61 |
// |
| 62 |
// To contact Route53 Recovery Cluster with the SDK use the New function to create |
| 63 |
// a new service client. With that client you can make API requests to the service. |
| 64 |
// These clients are safe to use concurrently. |
| 65 |
// |
| 66 |
// See the SDK's documentation for more information on how to use the SDK. |
| 67 |
// https://docs.aws.amazon.com/sdk-for-go/api/ |
| 68 |
// |
| 69 |
// See aws.Config documentation for more information on configuring SDK clients. |
| 70 |
// https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config |
| 71 |
// |
| 72 |
// See the Route53 Recovery Cluster client Route53RecoveryCluster for more |
| 73 |
// information on creating client for this service. |
| 74 |
// https://docs.aws.amazon.com/sdk-for-go/api/service/route53recoverycluster/#New |
| 75 |
package route53recoverycluster |