[ aws . neptune ]

describe-db-cluster-endpoints

Description

Returns information about endpoints for an Amazon Neptune DB cluster.

Note

This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

describe-db-cluster-endpoints is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: DBClusterEndpoints

Synopsis

  describe-db-cluster-endpoints
[--db-cluster-identifier <value>]
[--db-cluster-endpoint-identifier <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--db-cluster-identifier (string)

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

--db-cluster-endpoint-identifier (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 .

(structure)

This type is not currently supported.

Name -> (string)

This parameter is not currently supported.

Values -> (list)

This parameter is not currently supported.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

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.

(structure)

This data type represents the information you need to connect to an Amazon Neptune 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 Neptune 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 cannot 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.