AWS Route53 Recovery Control Config

2025/03/21 - AWS Route53 Recovery Control Config - 1 new3 updated api methods

Changes  Adds dual-stack (IPv4 and IPv6) endpoint support for route53-recovery-control-config operations, opt-in dual-stack addresses for cluster endpoints, and UpdateCluster API to update the network-type of clusters between IPv4 and dual-stack.

UpdateCluster (new) Link ¶

Updates an existing cluster. You can only update the network type of a cluster.

See also: AWS API Documentation

Request Syntax

client.update_cluster(
    ClusterArn='string',
    NetworkType='IPV4'|'DUALSTACK'
)
type ClusterArn:

string

param ClusterArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the cluster.

type NetworkType:

string

param NetworkType:

[REQUIRED]

The network type of the cluster. NetworkType can be one of the following: IPV4, DUALSTACK.

rtype:

dict

returns:

Response Syntax

{
    'Cluster': {
        'ClusterArn': 'string',
        'ClusterEndpoints': [
            {
                'Endpoint': 'string',
                'Region': 'string'
            },
        ],
        'Name': 'string',
        'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION',
        'Owner': 'string',
        'NetworkType': 'IPV4'|'DUALSTACK'
    }
}

Response Structure

  • (dict) --

    200 response - Success.

    • Cluster (dict) --

      The cluster that was updated.

      • ClusterArn (string) --

        The Amazon Resource Name (ARN) of the cluster.

      • ClusterEndpoints (list) --

        Endpoints for a cluster. Specify one of these endpoints when you want to set or retrieve a routing control state in the cluster.

        To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.

        • (dict) --

          A cluster endpoint. Specify an endpoint when you want to set or retrieve a routing control state in the cluster.

          • Endpoint (string) --

            A cluster endpoint. Specify an endpoint and Amazon Web Services Region when you want to set or retrieve a routing control state in the cluster.

            To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.

          • Region (string) --

            The Amazon Web Services Region for a cluster endpoint.

      • Name (string) --

        The name of the cluster.

      • Status (string) --

        Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

      • Owner (string) --

        The Amazon Web Services account ID of the cluster owner.

      • NetworkType (string) --

        The network type of the cluster. NetworkType can be one of the following: IPV4, DUALSTACK.

CreateCluster (updated) Link ¶
Changes (request, response)
Request
{'NetworkType': 'IPV4 | DUALSTACK'}
Response
{'Cluster': {'NetworkType': 'IPV4 | DUALSTACK'}}

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.

See also: AWS API Documentation

Request Syntax

client.create_cluster(
    ClientToken='string',
    ClusterName='string',
    Tags={
        'string': 'string'
    },
    NetworkType='IPV4'|'DUALSTACK'
)
type ClientToken:

string

param ClientToken:

A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.

This field is autopopulated if not provided.

type ClusterName:

string

param ClusterName:

[REQUIRED]

The name of the cluster.

type Tags:

dict

param Tags:

The tags associated with the cluster.

  • (string) --

    • (string) --

type NetworkType:

string

param NetworkType:

The network type of the cluster. NetworkType can be one of the following: IPV4, DUALSTACK.

rtype:

dict

returns:

Response Syntax

{
    'Cluster': {
        'ClusterArn': 'string',
        'ClusterEndpoints': [
            {
                'Endpoint': 'string',
                'Region': 'string'
            },
        ],
        'Name': 'string',
        'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION',
        'Owner': 'string',
        'NetworkType': 'IPV4'|'DUALSTACK'
    }
}

Response Structure

  • (dict) --

    200 response - Success.

    • Cluster (dict) --

      The cluster that was created.

      • ClusterArn (string) --

        The Amazon Resource Name (ARN) of the cluster.

      • ClusterEndpoints (list) --

        Endpoints for a cluster. Specify one of these endpoints when you want to set or retrieve a routing control state in the cluster.

        To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.

        • (dict) --

          A cluster endpoint. Specify an endpoint when you want to set or retrieve a routing control state in the cluster.

          • Endpoint (string) --

            A cluster endpoint. Specify an endpoint and Amazon Web Services Region when you want to set or retrieve a routing control state in the cluster.

            To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.

          • Region (string) --

            The Amazon Web Services Region for a cluster endpoint.

      • Name (string) --

        The name of the cluster.

      • Status (string) --

        Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

      • Owner (string) --

        The Amazon Web Services account ID of the cluster owner.

      • NetworkType (string) --

        The network type of the cluster. NetworkType can be one of the following: IPV4, DUALSTACK.

DescribeCluster (updated) Link ¶
Changes (response)
{'Cluster': {'NetworkType': 'IPV4 | DUALSTACK'}}

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

See also: AWS API Documentation

Request Syntax

client.describe_cluster(
    ClusterArn='string'
)
type ClusterArn:

string

param ClusterArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the cluster.

rtype:

dict

returns:

Response Syntax

{
    'Cluster': {
        'ClusterArn': 'string',
        'ClusterEndpoints': [
            {
                'Endpoint': 'string',
                'Region': 'string'
            },
        ],
        'Name': 'string',
        'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION',
        'Owner': 'string',
        'NetworkType': 'IPV4'|'DUALSTACK'
    }
}

Response Structure

  • (dict) --

    200 response - Success.

    • Cluster (dict) --

      The cluster for the DescribeCluster request.

      • ClusterArn (string) --

        The Amazon Resource Name (ARN) of the cluster.

      • ClusterEndpoints (list) --

        Endpoints for a cluster. Specify one of these endpoints when you want to set or retrieve a routing control state in the cluster.

        To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.

        • (dict) --

          A cluster endpoint. Specify an endpoint when you want to set or retrieve a routing control state in the cluster.

          • Endpoint (string) --

            A cluster endpoint. Specify an endpoint and Amazon Web Services Region when you want to set or retrieve a routing control state in the cluster.

            To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.

          • Region (string) --

            The Amazon Web Services Region for a cluster endpoint.

      • Name (string) --

        The name of the cluster.

      • Status (string) --

        Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

      • Owner (string) --

        The Amazon Web Services account ID of the cluster owner.

      • NetworkType (string) --

        The network type of the cluster. NetworkType can be one of the following: IPV4, DUALSTACK.

ListClusters (updated) Link ¶
Changes (response)
{'Clusters': {'NetworkType': 'IPV4 | DUALSTACK'}}

Returns an array of all the clusters in an account.

See also: AWS API Documentation

Request Syntax

client.list_clusters(
    MaxResults=123,
    NextToken='string'
)
type MaxResults:

integer

param MaxResults:

The number of objects that you want to return with this call.

type NextToken:

string

param NextToken:

The token that identifies which batch of results you want to see.

rtype:

dict

returns:

Response Syntax

{
    'Clusters': [
        {
            'ClusterArn': 'string',
            'ClusterEndpoints': [
                {
                    'Endpoint': 'string',
                    'Region': 'string'
                },
            ],
            'Name': 'string',
            'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION',
            'Owner': 'string',
            'NetworkType': 'IPV4'|'DUALSTACK'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    200 response - Success.

    • Clusters (list) --

      An array of the clusters in an account.

      • (dict) --

        A set of five redundant Regional endpoints against which you can execute API calls to update or get the state of routing controls. You can host multiple control panels and routing controls on one cluster.

        • ClusterArn (string) --

          The Amazon Resource Name (ARN) of the cluster.

        • ClusterEndpoints (list) --

          Endpoints for a cluster. Specify one of these endpoints when you want to set or retrieve a routing control state in the cluster.

          To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.

          • (dict) --

            A cluster endpoint. Specify an endpoint when you want to set or retrieve a routing control state in the cluster.

            • Endpoint (string) --

              A cluster endpoint. Specify an endpoint and Amazon Web Services Region when you want to set or retrieve a routing control state in the cluster.

              To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.

            • Region (string) --

              The Amazon Web Services Region for a cluster endpoint.

        • Name (string) --

          The name of the cluster.

        • Status (string) --

          Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

        • Owner (string) --

          The Amazon Web Services account ID of the cluster owner.

        • NetworkType (string) --

          The network type of the cluster. NetworkType can be one of the following: IPV4, DUALSTACK.

    • NextToken (string) --

      The token that identifies which batch of results you want to see.