Amazon Relational Database Service
API Reference (API Version 2014-10-31)

DBCluster

Contains the details of an Amazon Aurora DB cluster.

This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.

Contents

ActivityStreamKinesisStreamName

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

Type: String

Required: No

ActivityStreamKmsKeyId

The AWS KMS key identifier used for encrypting messages in the database activity stream.

Type: String

Required: No

ActivityStreamMode

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.

Type: String

Valid Values: sync | async

Required: No

ActivityStreamStatus

The status of the database activity stream.

Type: String

Valid Values: stopped | starting | started | stopping

Required: No

AllocatedStorage

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.

Type: Integer

Required: No

AssociatedRoles.DBClusterRole.N

Provides a list of the AWS 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 AWS services on your behalf.

Type: Array of DBClusterRole objects

Required: No

AvailabilityZones.AvailabilityZone.N

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

Type: Array of strings

Required: No

BacktrackConsumedChangeRecords

The number of change records stored for Backtrack.

Type: Long

Required: No

BacktrackWindow

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

Type: Long

Required: No

BackupRetentionPeriod

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

Type: Integer

Required: No

Capacity

The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) when the cluster is paused.

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

Type: Integer

Required: No

CharacterSetName

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

Type: String

Required: No

CloneGroupId

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

Type: String

Required: No

ClusterCreateTime

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

Type: Timestamp

Required: No

CopyTagsToSnapshot

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

Type: Boolean

Required: No

CrossAccountClone

Specifies whether the DB cluster is a clone of a DB cluster owned by a different AWS account.

Type: Boolean

Required: No

CustomEndpoints.member.N

Identifies all custom endpoints associated with the cluster.

Type: Array of strings

Required: No

DatabaseName

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.

Type: String

Required: No

DBClusterArn

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

Type: String

Required: No

DBClusterIdentifier

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

Type: String

Required: No

DBClusterMembers.DBClusterMember.N

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

Type: Array of DBClusterMember objects

Required: No

DBClusterOptionGroupMemberships.DBClusterOptionGroup.N

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

Type: Array of DBClusterOptionGroupStatus objects

Required: No

DBClusterParameterGroup

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

Type: String

Required: No

DbClusterResourceId

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

Type: String

Required: No

DBSubnetGroup

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

Type: String

Required: No

DeletionProtection

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

Type: Boolean

Required: No

EarliestBacktrackTime

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

Type: Timestamp

Required: No

EarliestRestorableTime

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

Type: Timestamp

Required: No

EnabledCloudwatchLogsExports.member.N

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.

Type: Array of strings

Required: No

Endpoint

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

Type: String

Required: No

Engine

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

Type: String

Required: No

EngineMode

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

Type: String

Required: No

EngineVersion

Indicates the database engine version.

Type: String

Required: No

HostedZoneId

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

Type: String

Required: No

HttpEndpointEnabled

A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless 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 in the Amazon Aurora User Guide.

Type: Boolean

Required: No

IAMDatabaseAuthenticationEnabled

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

Type: Boolean

Required: No

KmsKeyId

If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.

Type: String

Required: No

LatestRestorableTime

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

Type: Timestamp

Required: No

MasterUsername

Contains the master username for the DB cluster.

Type: String

Required: No

MultiAZ

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

Type: Boolean

Required: No

PercentProgress

Specifies the progress of the operation as a percentage.

Type: String

Required: No

Port

Specifies the port that the database engine is listening on.

Type: Integer

Required: No

PreferredBackupWindow

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

Type: String

Required: No

PreferredMaintenanceWindow

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

Type: String

Required: No

ReaderEndpoint

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.

Type: String

Required: No

ReadReplicaIdentifiers.ReadReplicaIdentifier.N

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

Type: Array of strings

Required: No

ReplicationSourceIdentifier

Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.

Type: String

Required: No

ScalingConfigurationInfo

Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

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

Type: ScalingConfigurationInfo object

Required: No

Status

Specifies the current state of this DB cluster.

Type: String

Required: No

StorageEncrypted

Specifies whether the DB cluster is encrypted.

Type: Boolean

Required: No

VpcSecurityGroups.VpcSecurityGroupMembership.N

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

Type: Array of VpcSecurityGroupMembership objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: