Route53RecoveryControlConfig / Client / update_cluster

update_cluster#

Route53RecoveryControlConfig.Client.update_cluster(**kwargs)#

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

Request Syntax

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

Parameters:

ClusterArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the cluster.
NetworkType (string) –
[REQUIRED]

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

Return type:

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.

Exceptions

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