aws.rds.describe_db_clusters
Example SQL Queries
SELECT * FROMaws.rds.describe_db_clusters;Description
Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
Table Definition
| Column Name | Column Data Type |
|---|---|
| db_cluster_identifier Input Column The user-supplied identifier for the DB cluster. 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:
| STRUCT( |
Show child fields
| |
| include_shared Input Column Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts. | BOOLEAN |
| _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( |
Show child fields
| |
| _aws_region Input Column The AWS region to use. | VARCHAR |
| activity_stream_kinesis_stream_name The name of the Amazon Kinesis data stream used for the database activity stream. | VARCHAR |
| activity_stream_kms_key_id The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. | VARCHAR |
| activity_stream_mode The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously. | VARCHAR |
| activity_stream_status The status of the database activity stream. | VARCHAR |
| allocated_storage For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed. | BIGINT |
| associated_roles A list of the Amazon Web Services 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 Web Services on your behalf. | STRUCT( |
Show child fields
| |
| auto_minor_version_upgrade Indicates whether minor version patches are applied automatically. This setting is only for non-Aurora Multi-AZ DB clusters. | BOOLEAN |
| automatic_restart_time The time when a stopped DB cluster is restarted automatically. | TIMESTAMP_S |
| availability_zones The list of Availability Zones (AZs) where instances in the DB cluster can be created. | VARCHAR[] |
Show child fields
| |
| aws_backup_recovery_point_arn The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup. | VARCHAR |
| backtrack_consumed_change_records The number of change records stored for Backtrack. | BIGINT |
| backtrack_window The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled. | BIGINT |
| backup_retention_period The number of days for which automatic DB snapshots are retained. | BIGINT |
| capacity The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused. For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide. | BIGINT |
| certificate_details The details of the DB instance’s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide. | STRUCT( |
Show child fields
| |
| character_set_name If present, specifies the name of the character set that this cluster is associated with. | VARCHAR |
| clone_group_id The ID of the clone group with which the DB cluster is associated. | VARCHAR |
| cluster_create_time The time when the DB cluster was created, in Universal Coordinated Time (UTC). | TIMESTAMP_S |
| copy_tags_to_snapshot Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster. | BOOLEAN |
| cross_account_clone Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account. | BOOLEAN |
| custom_endpoints The custom endpoints associated with the DB cluster. | VARCHAR[] |
Show child fields
| |
| database_name The name of the initial database that was specified for the DB cluster when it was created, if one was provided. 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_instance_class The name of the compute and memory capacity class of the DB instance. This setting is only for non-Aurora Multi-AZ DB clusters. | VARCHAR |
| db_cluster_members The list of DB instances that make up the DB cluster. | STRUCT( |
Show child fields
| |
| db_cluster_option_group_memberships The list of option group memberships for this DB cluster. | STRUCT( |
Show child fields
| |
| db_cluster_parameter_group The name of the DB cluster parameter group for the DB cluster. | VARCHAR |
| db_cluster_resource_id The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed. | VARCHAR |
| db_subnet_group Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group. | VARCHAR |
| db_system_id Reserved for future use. | VARCHAR |
| deletion_protection Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. | BOOLEAN |
| domain_memberships The Active Directory Domain membership records associated with the DB cluster. | STRUCT( |
Show child fields
| |
| earliest_backtrack_time The earliest time to which a DB cluster can be backtracked. | TIMESTAMP_S |
| earliest_restorable_time The earliest time to which a database can be restored with point-in-time restore. | TIMESTAMP_S |
| enabled_cloudwatch_logs_exports A list of log types that this DB cluster is configured to export to CloudWatch Logs. Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide. | VARCHAR[] |
Show child fields
| |
| endpoint The connection endpoint for the primary instance of the DB cluster. | VARCHAR |
| engine The database engine used for this DB cluster. | VARCHAR |
| engine_lifecycle_support The life cycle type for the DB cluster. For more information, see CreateDBCluster. | VARCHAR |
| engine_mode The DB engine mode of the DB cluster, either provisioned or serverless. For more information, see CreateDBCluster. | VARCHAR |
| engine_version The version of the database engine. | VARCHAR |
| global_write_forwarding_requested Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster. | BOOLEAN |
| global_write_forwarding_status The status of write forwarding for a secondary cluster in an Aurora global database. | VARCHAR |
| hosted_zone_id The ID that Amazon Route 53 assigns when you create a hosted zone. | VARCHAR |
| http_endpoint_enabled Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster. When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor. For more information, see Using RDS Data API in the Amazon Aurora User Guide. | BOOLEAN |
| iam_database_authentication_enabled Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. | BOOLEAN |
| io_optimized_next_allowed_modification_time The next time you can modify the DB cluster to use the aurora-iopt1 storage type. This setting is only for Aurora DB clusters. | TIMESTAMP_S |
| iops The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters. | BIGINT |
| kms_key_id If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. | VARCHAR |
| latest_restorable_time The latest time to which a database can be restored with point-in-time restore. | TIMESTAMP_S |
| limitless_database The details for Aurora Limitless Database. | STRUCT( |
Show child fields
| |
| local_write_forwarding_status Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it. | VARCHAR |
| master_user_secret The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password. For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide. | STRUCT( |
Show child fields
| |
| master_username The master username for the DB cluster. | VARCHAR |
| monitoring_interval The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. This setting is only for non-Aurora Multi-AZ DB clusters. | BIGINT |
| monitoring_role_arn The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. This setting is only for non-Aurora Multi-AZ DB clusters. | VARCHAR |
| multi_az Indicates whether the DB cluster has instances in multiple Availability Zones. | BOOLEAN |
| network_type The network type of the DB instance. The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL). For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide. This setting is only for Aurora DB clusters. Valid Values: IPV4 | DUAL | VARCHAR |
| pending_modified_values Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements. | STRUCT( |
Show child fields
| |
| percent_progress The progress of the operation as a percentage. | VARCHAR |
| performance_insights_enabled Indicates whether Performance Insights is enabled for the DB cluster. This setting is only for non-Aurora Multi-AZ DB clusters. | BOOLEAN |
| performance_insights_kms_key_id The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. This setting is only for non-Aurora Multi-AZ DB clusters. | VARCHAR |
| performance_insights_retention_period The number of days to retain Performance Insights data. This setting is only for non-Aurora Multi-AZ DB clusters. Valid Values:
Default: 7 days | BIGINT |
| port The port that the database engine is listening on. | BIGINT |
| preferred_backup_window The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. | VARCHAR |
| preferred_maintenance_window The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). | VARCHAR |
| publicly_accessible Indicates whether the DB cluster is publicly accessible. When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address. For more information, see CreateDBCluster. This setting is only for non-Aurora Multi-AZ DB clusters. | BOOLEAN |
| rds_custom_cluster_configuration Reserved for future use. | STRUCT( |
Show child fields
| |
| read_replica_identifiers Contains one or more identifiers of the read replicas associated with this DB cluster. | VARCHAR[] |
Show child fields
| |
| reader_endpoint The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster. If a failover occurs, and the Aurora 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 Aurora Replicas in the cluster, you can then reconnect to the reader endpoint. | VARCHAR |
| replication_source_identifier The identifier of the source DB cluster if this DB cluster is a read replica. | VARCHAR |
| scaling_configuration_info The scaling configuration for an Aurora DB cluster in serverless DB engine mode. For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide. | STRUCT( |
Show child fields
| |
| serverless_v2_scaling_configuration The scaling configuration for an Aurora Serverless v2 DB cluster. For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide. | STRUCT( |
Show child fields
| |
| status The current state of this DB cluster. | VARCHAR |
| status_infos Reserved for future use. | STRUCT( |
Show child fields
| |
| storage_encrypted Indicates whether the DB cluster is encrypted. | BOOLEAN |
| storage_throughput The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable. This setting is only for non-Aurora Multi-AZ DB clusters. | BIGINT |
| storage_type The storage type associated with the DB cluster. | VARCHAR |
| tag_list A list of tags. 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. | STRUCT( |
Show child fields
| |
| vpc_security_groups The list of VPC security groups that the DB cluster belongs to. | STRUCT( |
Show child fields
| |