Skip to main content

aws.rds.dbcluster

Supported platform

  • aws

Description

Amazon RDS database cluster

The aws.rds.dbcluster resource provides fields for assessing the configuration of AWS RDS Clusters.

Fields

IDTYPEDESCRIPTION
arnstringARN for the database cluster
regionstringRegion where the database cluster exists
idstringIdentifier for the database cluster
members[]aws.rds.dbinstanceList of database instances that belong to the cluster
snapshots[]aws.rds.snapshotList of snapshots for the cluster
tagsmap[string]stringTags for the database cluster
storageEncryptedboolWhether the cluster is encrypted
storageAllocatedintThe amount of storage, in GiB, provisioned on the cluster
storageIopsintThe storage IOPS provisioned on the cluster
storageTypestringThe type of storage provisioned on the cluster
statusstringCurrent state of the cluster
createdTimetimeThe creation date of the RDS cluster
backupRetentionPeriodintNumber of days for which automated snapshots are retained
autoMinorVersionUpgradeboolWhether minor version patches are applied automatically
clusterDbInstanceClassstringName of the compute and memory capacity class of the Cluster DB instances
enginestringName of the database engine for this DB cluster
engineVersionstringThe version of the database engine for this DB cluster
publiclyAccessibleboolWhether the cluster is publicly accessible
multiAZboolWhether the cluster is a Multi-AZ deployment
deletionProtectionboolWhether deletion protection is enabled
securityGroups[]aws.ec2.securitygroupList of VPC security group elements that the DB cluster belongs to
availabilityZones[]stringList of Availability Zones (AZs) where instances in the DB cluster can be created
portintThe port that the database engine is listening on
endpointstringThe connection endpoint for the primary instance of the DB cluster
hostedZoneIdstringThe cluster hosted zone ID
masterUsernamestringThe master username for the DB instance
latestRestorableTimetimeThe latest time to which a database can be restored with point-in-time restore