AWS RDS

List DB clusters

List existing Amazon Aurora DB clusters and Multi-AZ DB clusters.

Inputs

Field

Type

Description

region [required]

enum

default: us-east-1

limit

number

Maximum number of records to include in the response.

default: 100

Outputs

Expand All

Field

Type

Description

dbClusters [required]

[object]

AllocatedStorage

number

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.

AvailabilityZones

[string]

Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

BackupRetentionPeriod

number

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

CharacterSetName

string

If present, specifies the name of the character set that this cluster is associated with.

DatabaseName

string

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.

DBClusterIdentifier

string

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

DBClusterParameterGroup

string

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

DBSubnetGroup

string

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

Status

string

Specifies the current state of this DB cluster.

AutomaticRestartTime

date-time

The time when a stopped DB cluster is restarted automatically.

PercentProgress

string

Specifies the progress of the operation as a percentage.

EarliestRestorableTime

date-time

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

Endpoint

string

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

ReaderEndpoint

string

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.

CustomEndpoints

[string]

Identifies all custom endpoints associated with the cluster.

MultiAZ

boolean

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

Engine

string

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

EngineVersion

string

Indicates the database engine version.

LatestRestorableTime

date-time

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

Port

number

Specifies the port that the database engine is listening on.

MasterUsername

string

Contains the master username for the DB cluster.

DBClusterOptionGroupMemberships

[object]

Provides the list of option group memberships for this DB cluster.

DBClusterOptionGroupName

string

Specifies the name of the DB cluster option group.

Status

string

Specifies the status of the DB cluster option group.

PreferredBackupWindow

string

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

PreferredMaintenanceWindow

string

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

ReplicationSourceIdentifier

string

Contains the identifier of the source DB cluster if this DB cluster is a read replica.

ReadReplicaIdentifiers

[string]

Contains one or more identifiers of the read replicas associated with this DB cluster.

DBClusterMembers

[object]

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

DBInstanceIdentifier

string

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

IsClusterWriter

boolean

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

DBClusterParameterGroupStatus

string

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

PromotionTier

number

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

VpcSecurityGroups

[object]

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

VpcSecurityGroupId

string

The name of the VPC security group.

Status

string

The status of the VPC security group.

HostedZoneId

string

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

StorageEncrypted

boolean

Specifies whether the DB cluster is encrypted.

KmsKeyId

string

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.

DbClusterResourceId

string

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.

DBClusterArn

string

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

AssociatedRoles

[object]

Provides 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.

RoleArn

string

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

Status

string

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 Web 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 Web Services on your behalf.

FeatureName

string

The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.

IAMDatabaseAuthenticationEnabled

boolean

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

CloneGroupId

string

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

ClusterCreateTime

date-time

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

EarliestBacktrackTime

date-time

The earliest time to which a DB cluster can be backtracked.

BacktrackWindow

number

The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

BacktrackConsumedChangeRecords

number

The number of change records stored for Backtrack.

EnabledCloudwatchLogsExports

[string]

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.

Capacity

number

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.

EngineMode

string

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. For more information, see CreateDBCluster.

ScalingConfigurationInfo

object

MinCapacity

number

The maximum capacity for the Aurora DB cluster in serverless DB engine mode.

MaxCapacity

number

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

AutoPause

boolean

A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode. When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.

SecondsUntilAutoPause

number

The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).

TimeoutAction

string

The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange. ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible. RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.

SecondsBeforeTimeout

number

The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.

DeletionProtection

boolean

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

HttpEndpointEnabled

boolean

A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled. When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor. For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.

ActivityStreamMode

string

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.

ActivityStreamStatus

string

The status of the database activity stream.

ActivityStreamKmsKeyId

string

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.

ActivityStreamKinesisStreamName

string

The name of the Amazon Kinesis data stream used for the database activity stream.

CopyTagsToSnapshot

boolean

Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

CrossAccountClone

boolean

Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

DomainMemberships

[object]

The Active Directory Domain membership records associated with the DB cluster.

Domain

string

The identifier of the Active Directory Domain.

Status

string

The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.

FQDN

string

The fully qualified domain name of the Active Directory Domain.

IAMRoleName

string

The name of the IAM role to be used when making API calls to the Directory Service.

TagList

[object]

Key

string

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}.:/=+\-@]*)$").

Value

string

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}.:/=+\-@]*)$").

GlobalWriteForwardingStatus

string

Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

GlobalWriteForwardingRequested

boolean

Specifies whether you have requested to enable write forwarding 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.

PendingModifiedValues

object

A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

PendingCloudwatchLogsExports

object

LogTypesToEnable

[string]

Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

LogTypesToDisable

[string]

Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

DBClusterIdentifier

string

The DBClusterIdentifier value for the DB cluster.

MasterUserPassword

string

The master credentials for the DB cluster.

IAMDatabaseAuthenticationEnabled

boolean

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

EngineVersion

string

The database engine version.

DBClusterInstanceClass

string

The name of the compute and memory capacity class of the DB instance. This setting is only for non-Aurora Multi-AZ DB clusters.

StorageType

string

The storage type associated with the DB cluster. This setting is only for non-Aurora Multi-AZ DB clusters.

Iops

number

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

PubliclyAccessible

boolean

Specifies the accessibility options for the DB instance. When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance. This setting is only for non-Aurora Multi-AZ DB clusters.

AutoMinorVersionUpgrade

boolean

A value that indicates that minor version patches are applied automatically. This setting is only for non-Aurora Multi-AZ DB clusters.

MonitoringInterval

number

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.

MonitoringRoleArn

string

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.

PerformanceInsightsEnabled

boolean

True if Performance Insights is enabled for the DB cluster, and otherwise false. This setting is only for non-Aurora Multi-AZ DB clusters.

PerformanceInsightsKMSKeyId

string

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.

PerformanceInsightsRetentionPeriod

number

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years). This setting is only for non-Aurora Multi-AZ DB clusters.

ServerlessV2ScalingConfiguration

object

MinCapacity

number

The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.

MaxCapacity

number

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.