Skip to content
AWS for Query.Farm

aws.neptune.describe_db_cluster_endpoints

Example SQL Queries

SELECT * FROM
aws.neptune.describe_db_cluster_endpoints;

Description

Returns information about endpoints for an Amazon Neptune DB cluster.

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

Table Definition

Column NameColumn Data Type
db_cluster_endpoint_identifier Input Column

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

VARCHAR
db_cluster_identifier Input Column

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

VARCHAR
filters Input Column

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. 

STRUCT(
    "name" VARCHAR,
    "values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

This parameter is not currently supported.

filters[].values[]
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
custom_endpoint_type

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

VARCHAR
db_cluster_endpoint_arn

The Amazon Resource Name (ARN) for the endpoint.

VARCHAR
db_cluster_endpoint_resource_identifier

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

VARCHAR
endpoint

The DNS address of the endpoint.

VARCHAR
endpoint_type

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

VARCHAR
excluded_members

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.

VARCHAR[]
Show child fields
excluded_members[]
static_members

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

VARCHAR[]
Show child fields
static_members[]
status

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.

VARCHAR