Route53RecoveryControlConfig / Client / create_cluster

create_cluster#

Route53RecoveryControlConfig.Client.create_cluster(**kwargs)#

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.

Request Syntax

response = client.create_cluster(
    ClientToken='string',
    ClusterName='string',
    Tags={
        'string': 'string'
    }
)

Parameters:

ClientToken (string) –
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.
ClusterName (string) –
[REQUIRED]

The name of the cluster.
Tags (dict) –
The tags associated with the cluster.
- (string) –
  - (string) –

Return type:

dict

Returns:

Response Syntax

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

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.

Exceptions

Route53RecoveryControlConfig.Client.exceptions.ValidationException
Route53RecoveryControlConfig.Client.exceptions.InternalServerException
Route53RecoveryControlConfig.Client.exceptions.ServiceQuotaExceededException
Route53RecoveryControlConfig.Client.exceptions.AccessDeniedException
Route53RecoveryControlConfig.Client.exceptions.ResourceNotFoundException
Route53RecoveryControlConfig.Client.exceptions.ThrottlingException
Route53RecoveryControlConfig.Client.exceptions.ConflictException