RDS / Client / describe_db_cluster_endpoints

describe_db_cluster_endpoints

RDS.Client.describe_db_cluster_endpoints(**kwargs)

Returns information about endpoints for an Amazon Aurora DB cluster.

Note

This action only applies to Aurora DB clusters.

See also: AWS API Documentation

Request Syntax

response = client.describe_db_cluster_endpoints(
    DBClusterIdentifier='string',
    DBClusterEndpointIdentifier='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)

Parameters:

• DBClusterIdentifier (string) – The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

• DBClusterEndpointIdentifier (string) – The identifier of the endpoint to describe. This parameter is stored as a lowercase string.

• Filters (list) –

  A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying.

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

    Note

    Currently, wildcards are not supported in filters.

    The following actions can be filtered:

    • DescribeDBClusterBacktracks

    • DescribeDBClusterEndpoints

    • DescribeDBClusters

    • DescribeDBInstances

    • DescribePendingMaintenanceActions

    • Name (string) – [REQUIRED]

      The name of the filter. Filter names are case-sensitive.

    • Values (list) – [REQUIRED]

      One or more filter values. Filter values are case-sensitive.

      • (string) –

• MaxRecords (integer) –

  The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

  Default: 100

  Constraints: Minimum 20, maximum 100.

• Marker (string) – An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • Marker (string) –

    An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

  • DBClusterEndpoints (list) –

    Contains the details of the endpoints associated with the cluster and matching any filter conditions.

    • (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.DBClusterNotFoundFault