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
| ID | TYPE | DESCRIPTION |
|---|---|---|
| arn | string | ARN for the database cluster |
| region | string | Region where the database cluster exists |
| id | string | Identifier for the database cluster |
| members | []aws.rds.dbinstance | List of database instances that belong to the cluster |
| snapshots | []aws.rds.snapshot | List of snapshots for the cluster |
| tags | map[string]string | Tags for the database cluster |
| storageEncrypted | bool | Whether the cluster is encrypted |
| storageAllocated | int | The amount of storage, in GiB, provisioned on the cluster |
| storageIops | int | The storage IOPS provisioned on the cluster |
| storageType | string | The type of storage provisioned on the cluster |
| status | string | Current state of the cluster |
| createdTime | time | The creation date of the RDS cluster |
| backupRetentionPeriod | int | Number of days for which automated snapshots are retained |
| autoMinorVersionUpgrade | bool | Whether minor version patches are applied automatically |
| clusterDbInstanceClass | string | Name of the compute and memory capacity class of the cluster database instances |
| engine | string | Name of the database engine for this database cluster |
| engineVersion | string | The version of the database engine for this DB cluster |
| publiclyAccessible | bool | Whether the cluster is publicly accessible |
| multiAZ | bool | Whether the cluster is a Multi-AZ deployment |
| deletionProtection | bool | Whether deletion protection is enabled |
| securityGroups | []aws.ec2.securitygroup | List of VPC security group elements that the database cluster belongs to |
| availabilityZones | []string | List of Availability Zones (AZs) where instances in the database cluster can be created |
| port | int | The port that the database engine is listening on |
| endpoint | string | The connection endpoint for the primary instance of the database cluster |
| hostedZoneId | string | The cluster hosted zone ID |
| masterUsername | string | The master username for the database |
| latestRestorableTime | time | The latest time to which a database can be restored with point-in-time restore |
| backupSettings | []aws.rds.backupsetting | Backup setting for the database cluster |