Skip to main content
Version: Next

db_cluster

Table to manage Multi-AZ DB cluster instances. A Multi-AZ DB cluster deployment is a high availability deployment mode of Amazon RDS with two readable standby DB instances. A Multi-AZ DB cluster has a writer DB instance and two reader DB instances in three separate Availability Zones in the same AWS Region. Multi-AZ DB clusters provide high availability, increased capacity for read workloads, and lower write latency when compared to Multi-AZ DB instance deployments.

See

https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html

Columns

allocated_storage: number

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

See

https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS

Optional arn: string

ARN for the generated db cluster

Optional backup_retention_period: number

The number of days for which automated backups are retained.

db_cluster_identifier: string

Name for the databae

db_cluster_instance_class: string

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster. Valid only for multi-az clusters.

See

https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html

deletion_protection: boolean

A value that indicates whether the DB cluster has deletion protection enabled.

Optional engine: db_cluster_engine

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

Optional engine_version: string

The version number of the database engine to use.

iops: number

The number of I/O operations per second (IOPS)

See

https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS

Optional master_user_password: string

The password for the master database user.

master_username: string

The name of the master user for the DB cluster.

Optional port: number

The port number on which the instances in the DB cluster accept connections.

publicly_accessible: boolean

A value that indicates whether the DB cluster is publicly accessible.

See

https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rds/interfaces/createdbclustercommandinput.html#publiclyaccessible

region: string

Region for the cluster. Support for multi-az clusters may be limited on different regions. Please check AWS documentation for more details.

storage_encrypted: boolean

A value that indicates whether the DB cluster is encrypted.

subnet_group: db_subnet_group

Reference to the subnet groups associated with the cluster

Optional tags: Object

Complex type to provide identifier tags

See

https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rds/interfaces/tag.html

Type definition

[key: string]: string

vpc_security_groups: security_group[]

Reference to the VPC security groups for the database

See

https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.RDSSecurityGroups.html