RDS / Client / create_db_cluster_endpoint

create_db_cluster_endpoint

RDS.Client.create_db_cluster_endpoint(**kwargs)

Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

Note

This action applies only to Aurora DB clusters.

See also: AWS API Documentation

Request Syntax

response = client.create_db_cluster_endpoint(
    DBClusterIdentifier='string',
    DBClusterEndpointIdentifier='string',
    EndpointType='string',
    StaticMembers=[
        'string',
    ],
    ExcludedMembers=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• DBClusterIdentifier (string) –

  [REQUIRED]

  The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

• DBClusterEndpointIdentifier (string) –

  [REQUIRED]

  The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

• EndpointType (string) –

  [REQUIRED]

  The type of the endpoint, one of: READER, WRITER, ANY.

• StaticMembers (list) –

  List of DB instance identifiers that are part of the custom endpoint group.

  • (string) –

• ExcludedMembers (list) –

  List of DB instance identifiers that aren’t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. This parameter is relevant only if the list of static members is empty.

  • (string) –

• Tags (list) –

  The tags to be assigned to the Amazon RDS resource.

  • (dict) –

    Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

    For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

    • Key (string) –

      A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

    • Value (string) –

      A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

Return type:

dict

Returns:

Response Syntax

{
    'DBClusterEndpointIdentifier': 'string',
    'DBClusterIdentifier': 'string',
    'DBClusterEndpointResourceIdentifier': 'string',
    'Endpoint': 'string',
    'Status': 'string',
    'EndpointType': 'string',
    'CustomEndpointType': 'string',
    'StaticMembers': [
        'string',
    ],
    'ExcludedMembers': [
        'string',
    ],
    'DBClusterEndpointArn': 'string'
}

Response Structure

• (dict) –

  This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:

  • CreateDBClusterEndpoint

  • DescribeDBClusterEndpoints

  • ModifyDBClusterEndpoint

  • DeleteDBClusterEndpoint

  For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.

  • DBClusterEndpointIdentifier (string) –

    The identifier associated with the endpoint. This parameter is stored as a lowercase string.

  • DBClusterIdentifier (string) –

    The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

  • DBClusterEndpointResourceIdentifier (string) –

    A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

  • Endpoint (string) –

    The DNS address of the endpoint.

  • Status (string) –

    The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can’t be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

  • EndpointType (string) –

    The type of the endpoint. One of: READER, WRITER, CUSTOM.

  • CustomEndpointType (string) –

    The type associated with a custom endpoint. One of: READER, WRITER, ANY.

  • StaticMembers (list) –

    List of DB instance identifiers that are part of the custom endpoint group.

    • (string) –

  • ExcludedMembers (list) –

    List of DB instance identifiers that aren’t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

    • (string) –

  • DBClusterEndpointArn (string) –

    The Amazon Resource Name (ARN) for the endpoint.

Exceptions

• RDS.Client.exceptions.DBClusterEndpointQuotaExceededFault

• RDS.Client.exceptions.DBClusterEndpointAlreadyExistsFault

• RDS.Client.exceptions.DBClusterNotFoundFault

• RDS.Client.exceptions.InvalidDBClusterStateFault

• RDS.Client.exceptions.DBInstanceNotFoundFault

• RDS.Client.exceptions.InvalidDBInstanceStateFault