github.com/aavshr/aws-sdk-go@v1.41.3/service/route53recoverycluster/doc.go (about)

     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 Amazon Route 53 Application Recovery Controller API Reference
     7  // Guide for Recovery Control Data Plane .
     8  //
     9  // Recovery control in Route 53 Application Recovery Controller includes extremely
    10  // reliable routing controls that enable you to recover applications by rerouting
    11  // traffic, for example, across Availability Zones or AWS Regions. Routing controls
    12  // are simple on/off switches hosted on a cluster. A cluster is a set of five
    13  // redundant regional endpoints against which you can execute API calls to update
    14  // or get the state of routing controls. You use routing controls to failover
    15  // traffic to recover your application across Availability Zones or Regions.
    16  //
    17  // This API guide includes information about how to get and update routing control
    18  // states in Route 53 Application Recovery Controller.
    19  //
    20  // For more information about Route 53 Application Recovery Controller, see
    21  // the following:
    22  //
    23  //    * You can create clusters, routing controls, and control panels by using
    24  //    the control plane API for Recovery Control. For more information, see
    25  //    Amazon Route 53 Application Recovery Controller Recovery Control API Reference
    26  //    (https://docs.aws.amazon.com/recovery-cluster/latest/api/).
    27  //
    28  //    * Route 53 Application Recovery Controller also provides continuous readiness
    29  //    checks to ensure that your applications are scaled to handle failover
    30  //    traffic. For more information about the related API actions, see Amazon
    31  //    Route 53 Application Recovery Controller Recovery Readiness API Reference
    32  //    (https://docs.aws.amazon.com/recovery-readiness/latest/api/).
    33  //
    34  //    * For more information about creating resilient applications and preparing
    35  //    for recovery readiness with Route 53 Application Recovery Controller,
    36  //    see the Amazon Route 53 Application Recovery Controller Developer Guide
    37  //    (r53recovery/latest/dg/).
    38  //
    39  // See https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-cluster-2019-12-02 for more information on this service.
    40  //
    41  // See route53recoverycluster package documentation for more information.
    42  // https://docs.aws.amazon.com/sdk-for-go/api/service/route53recoverycluster/
    43  //
    44  // Using the Client
    45  //
    46  // To contact Route53 Recovery Cluster with the SDK use the New function to create
    47  // a new service client. With that client you can make API requests to the service.
    48  // These clients are safe to use concurrently.
    49  //
    50  // See the SDK's documentation for more information on how to use the SDK.
    51  // https://docs.aws.amazon.com/sdk-for-go/api/
    52  //
    53  // See aws.Config documentation for more information on configuring SDK clients.
    54  // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
    55  //
    56  // See the Route53 Recovery Cluster client Route53RecoveryCluster for more
    57  // information on creating client for this service.
    58  // https://docs.aws.amazon.com/sdk-for-go/api/service/route53recoverycluster/#New
    59  package route53recoverycluster