Skip to content
AWS for Query.Farm

aws.neptune.describe_db_clusters

Example SQL Queries

SELECT * FROM
aws.neptune.describe_db_clusters;

Description

Returns information about provisioned DB clusters, and supports pagination.

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

Table Definition

Column NameColumn Data Type
db_cluster_identifier Input Column

Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

VARCHAR
filters Input Column

A filter that specifies one or more DB clusters to describe.

Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.

  • engine - Accepts an engine name (such as neptune), and restricts the results list to DB clusters created by that engine.

For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB clusters are returned, you could use the following command:

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
allocated_storage

AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

BIGINT
associated_roles

Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf.

STRUCT(
    "role_arn" VARCHAR,
    "status" VARCHAR,
    "feature_name" VARCHAR
)[]
Show child fields
associated_roles[]
Show child fields
associated_roles[].feature_name

The name of the feature associated with the Amazon Identity and Access Management (IAM) role. For the list of supported feature names, see DescribeDBEngineVersions.

associated_roles[].role_arn

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

associated_roles[].status

Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:

  • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon services on your behalf.

  • PENDING - the IAM role ARN is being associated with the DB cluster.

  • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon services on your behalf.

automatic_restart_time

Time at which the DB cluster will be automatically restarted.

TIMESTAMP_S
availability_zones

Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

VARCHAR[]
Show child fields
availability_zones[]
backup_retention_period

Specifies the number of days for which automatic DB snapshots are retained.

BIGINT
character_set_name

Not supported by Neptune.

VARCHAR
clone_group_id

Identifies the clone group to which the DB cluster is associated.

VARCHAR
cluster_create_time

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

TIMESTAMP_S
copy_tags_to_snapshot

If set to true, tags are copied to any snapshot of the DB cluster that is created. 

BOOLEAN
cross_account_clone

If set to true, the DB cluster can be cloned across accounts.

BOOLEAN
database_name

Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

VARCHAR
db_cluster_arn

The Amazon Resource Name (ARN) for the DB cluster.

VARCHAR
db_cluster_members

Provides the list of instances that make up the DB cluster.

STRUCT(
    "db_instance_identifier" VARCHAR,
    "is_cluster_writer" BOOLEAN,
    "db_cluster_parameter_group_status" VARCHAR,
    "promotion_tier" BIGINT
)[]
Show child fields
db_cluster_members[]
Show child fields
db_cluster_members[].db_cluster_parameter_group_status

Specifies the status of the DB cluster parameter group for this member of the DB cluster.

db_cluster_members[].db_instance_identifier

Specifies the instance identifier for this member of the DB cluster.

db_cluster_members[].is_cluster_writer

Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

db_cluster_members[].promotion_tier

A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

db_cluster_option_group_memberships

Not supported by Neptune.

STRUCT(
    "db_cluster_option_group_name" VARCHAR,
    "status" VARCHAR
)[]
Show child fields
db_cluster_option_group_memberships[]
Show child fields
db_cluster_option_group_memberships[].db_cluster_option_group_name

Not supported by Neptune.

db_cluster_option_group_memberships[].status

Not supported by Neptune.

db_cluster_parameter_group

Specifies the name of the DB cluster parameter group for the DB cluster.

VARCHAR
db_cluster_resource_id

The Amazon Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon CloudTrail log entries whenever the Amazon KMS key for the DB cluster is accessed.

VARCHAR
db_subnet_group

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

VARCHAR
deletion_protection

Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

BOOLEAN
earliest_restorable_time

Specifies the earliest time to which a database can be restored with point-in-time restore.

TIMESTAMP_S
enabled_cloudwatch_logs_exports

A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: audit (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See Publishing Neptune logs to Amazon CloudWatch logs.

VARCHAR[]
Show child fields
enabled_cloudwatch_logs_exports[]
endpoint

Specifies the connection endpoint for the primary instance of the DB cluster.

VARCHAR
engine

Provides the name of the database engine to be used for this DB cluster.

VARCHAR
engine_version

Indicates the database engine version.

VARCHAR
global_cluster_identifier

Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.

VARCHAR
hosted_zone_id

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

VARCHAR
iam_database_authentication_enabled

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

BOOLEAN
io_optimized_next_allowed_modification_time

The next time you can modify the DB cluster to use the iopt1 storage type.

TIMESTAMP_S
kms_key_id

If StorageEncrypted is true, the Amazon KMS key identifier for the encrypted DB cluster.

VARCHAR
latest_restorable_time

Specifies the latest time to which a database can be restored with point-in-time restore.

TIMESTAMP_S
master_username

Not supported by Neptune.

VARCHAR
multi_az

Specifies whether the DB cluster has instances in multiple Availability Zones.

BOOLEAN
pending_modified_values

This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

STRUCT(
    "pending_cloudwatch_logs_exports" STRUCT(
        "log_types_to_enable" VARCHAR[],
        "log_types_to_disable" VARCHAR[]
    ),
    "db_cluster_identifier" VARCHAR,
    "iam_database_authentication_enabled" BOOLEAN,
    "engine_version" VARCHAR,
    "backup_retention_period" BIGINT,
    "storage_type" VARCHAR,
    "allocated_storage" BIGINT,
    "iops" BIGINT
)
Show child fields
pending_modified_values.allocated_storage

The allocated storage size in gibibytes (GiB) for database engines. For Neptune, AllocatedStorage always returns 1, because Neptune DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

pending_modified_values.backup_retention_period

The number of days for which automatic DB snapshots are retained.

pending_modified_values.db_cluster_identifier

The DBClusterIdentifier value for the DB cluster.

pending_modified_values.engine_version

The database engine version.

pending_modified_values.iam_database_authentication_enabled

A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

pending_modified_values.iops

The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

pending_modified_values.pending_cloudwatch_logs_exports

This PendingCloudwatchLogsExports structure specifies pending changes to which CloudWatch logs are enabled and which are disabled.

Show child fields
pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable[]
pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable[]
pending_modified_values.storage_type

The storage type for the DB cluster.

percent_progress

Specifies the progress of the operation as a percentage.

VARCHAR
port

Specifies the port that the database engine is listening on.

BIGINT
preferred_backup_window

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

VARCHAR
preferred_maintenance_window

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

VARCHAR
read_replica_identifiers

Contains one or more identifiers of the Read Replicas associated with this DB cluster.

VARCHAR[]
Show child fields
read_replica_identifiers[]
reader_endpoint

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can help balance your read workload across multiple Read Replicas in your DB cluster.

If a failover occurs, and the Read Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Read Replicas in the cluster, you can then reconnect to the reader endpoint.

VARCHAR
replication_source_identifier

Not supported by Neptune.

VARCHAR
serverless_v2_scaling_configuration

Shows the scaling configuration for a Neptune Serverless DB cluster.

For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

STRUCT(
    "min_capacity" DOUBLE,
    "max_capacity" DOUBLE
)
Show child fields
serverless_v2_scaling_configuration.max_capacity

The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.

serverless_v2_scaling_configuration.min_capacity

The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

status

Specifies the current state of this DB cluster.

VARCHAR
storage_encrypted

Specifies whether the DB cluster is encrypted.

BOOLEAN
storage_type

The storage type associated with the DB cluster.

VARCHAR
vpc_security_groups

Provides a list of VPC security groups that the DB cluster belongs to.

STRUCT(
    "vpc_security_group_id" VARCHAR,
    "status" VARCHAR
)[]
Show child fields
vpc_security_groups[]
Show child fields
vpc_security_groups[].status

The status of the VPC security group.

vpc_security_groups[].vpc_security_group_id

The name of the VPC security group.