aws.rds.dbinstance
Supported platform
- aws
Description
Amazon RDS database instance
The aws.rds.dbinstance resource provides fields for assessing the configuration of RDS instances. For usage, read the aws.rds resource documentation.
Fields
| ID | TYPE | DESCRIPTION |
|---|---|---|
| arn | string | ARN for the database instance |
| id | string | Identifier for the database instance |
| name | string | Name of the database instance |
| backupRetentionPeriod | int | Number of days automated snapshots are retained |
| snapshots | []aws.rds.snapshot | List of snapshots for the database instance |
| storageEncrypted | bool | Whether the instance is encrypted |
| storageAllocated | int | Amount of storage, in GiB, provisioned on the instance |
| storageIops | int | Storage IOPS provisioned on the instance |
| storageType | string | Type of storage provisioned on the instance |
| region | string | Region where the instance exists |
| availabilityZone | string | Availability zone where the instance exists |
| publiclyAccessible | bool | Whether the instance is publicly accessible |
| enabledCloudwatchLogsExports | []string | List of log types the instance is configured to export to CloudWatch logs |
| deletionProtection | bool | Whether deletion protection is enabled |
| multiAZ | bool | Whether the instance is a Multi-AZ deployment |
| monitoringInterval | int | Interval, in seconds, between points when Enhanced Monitoring metrics are collected |
| enhancedMonitoringResourceArn | string | ARN of the CloudWatch log stream that receives the enhanced monitoring metrics data |
| tags | map[string]string | Tags for the database instance |
| dbInstanceClass | string | Name of the compute and memory capacity class of the database instance |
| dbInstanceIdentifier | string | User-supplied unique key that identifies a database instance |
| engine | string | Name of the database engine for this database instance |
| engineVersion | string | Version of the database engine for this database instance |
| securityGroups | []aws.ec2.securitygroup | List of VPC security group elements that the database instance belongs to |
| status | string | Current state of this database |
| autoMinorVersionUpgrade | bool | Whether minor version patches are applied automatically |
| createdTime | time | Creation date of the RDS instance |
| port | int | Port that the database instance listens on. If the database instance is part of a DB cluster, this can be a different port than the DB cluster port. |
| endpoint | string | Connection endpoint for the database instance |
| masterUsername | string | Master username for the database instance |
| latestRestorableTime | time | Latest time to which a database can be restored with point-in-time restore |
| backupSettings | []aws.rds.backupsetting | Backup setting for the database instance |
| subnets | []aws.vpc.subnet | Subnet for the RDS instance |
| engineLifecycleSupport | string | Life cycle type for the database engine. By default, this value is set to open-source-rds-extended-support, which enrolls your DB engine into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB engine will fail if the DB major version is past its end of standard support date. |
| certificateExpiresAt | time | Expiration date for the instance certificate |
| certificateAuthority | string | ID of the Certificate Authority |
| iamDatabaseAuthentication | bool | Whether IAM database authentication is enabled |
| customIamInstanceProfile | string | Assigned IAM instance profile |
| activityStreamMode | string | Mode of the database activity stream |
| activityStreamStatus | string | Status of the database activity stream |
| pendingMaintenanceActions | []aws.rds.pendingMaintenanceAction | List of pending maintenance actions for the database instance |
| networkType | string | Network type of the DB instance |
| preferredMaintenanceWindow | string | Preferred maintenance window for the database cluster |
| preferredBackupWindow | string | Preferred backup window for the database cluster |