RDS Instance

This table represents the RDS Instance resource from Amazon Web Services.

aws.rds_instance

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
activity_stream_engine_native_audit_fields_includedcoreboolIndicates whether engine-native audit fields are included in the database activity stream.
activity_stream_kinesis_stream_namecorestringThe name of the Amazon Kinesis data stream used for the database activity stream.
activity_stream_kms_key_idcorestringThe Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
activity_stream_modecorestringThe mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
activity_stream_policy_statuscorestringThe status of the policy state of the activity stream.
activity_stream_statuscorestringThe status of the database activity stream.
allocated_storagecoreint64The amount of storage in gibibytes (GiB) allocated for the DB instance.
associated_rolescorejsonThe Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
auto_minor_version_upgradecoreboolIndicates whether minor version patches are applied automatically.
automatic_restart_timecoretimestampThe time when a stopped DB instance is restarted automatically.
automation_modecorestringThe automation mode of the RDS Custom DB instance: <code>full</code> or <code>all paused</code>. If <code>full</code>, the DB instance automates monitoring and instance recovery. If <code>all paused</code>, the instance pauses automation for the duration set by <code>--resume-full-automation-mode-minutes</code>.
availability_zonecorestringThe name of the Availability Zone where the DB instance is located.
aws_backup_recovery_point_arncorestringThe Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
backup_retention_periodcoreint64The number of days for which automatic DB snapshots are retained.
backup_targetcorestringThe location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
ca_certificate_identifiercorestringThe identifier of the CA certificate for this DB instance. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html">Using SSL/TLS to encrypt a connection to a DB instance</a> in the <i>Amazon RDS User Guide</i> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html"> Using SSL/TLS to encrypt a connection to a DB cluster</a> in the <i>Amazon Aurora User Guide</i>.
certificate_detailscorejsonThe details of the DB instance's server certificate.
character_set_namecorestringIf present, specifies the name of the character set that this instance is associated with.
copy_tags_to_snapshotcoreboolIndicates whether tags are copied from the DB instance to snapshots of the DB instance. This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see <code>DBCluster</code>.
custom_iam_instance_profilecorestringThe instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements: <ul> <li> The profile must exist in your account. </li> <li> The profile must have an IAM role that Amazon EC2 has permissions to assume. </li> <li> The instance profile name and the associated IAM role name must start with the prefix <code>AWSRDSCustom</code>. </li> </ul> For the list of permissions required for the IAM role, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc"> Configure IAM and your VPC</a> in the <i>Amazon RDS User Guide</i>.
customer_owned_ip_enabledcoreboolIndicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance. A <i>CoIP </i>provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network. For more information about RDS on Outposts, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html">Working with Amazon RDS on Amazon Web Services Outposts</a> in the <i>Amazon RDS User Guide</i>. For more information about CoIPs, see <a href="https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing">Customer-owned IP addresses</a> in the <i>Amazon Web Services Outposts User Guide</i>.
database_insights_modecorestringThe mode of Database Insights that is enabled for the instance.
db_cluster_identifiercorestringIf the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.
db_instance_arncorestringThe Amazon Resource Name (ARN) for the DB instance.
db_instance_automated_backups_replicationscorejsonThe list of replicated automated backups associated with the DB instance.
db_instance_classcorestringThe name of the compute and memory capacity class of the DB instance.
db_instance_identifiercorestringThe user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
db_instance_portcoreint64The port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
db_instance_statuscorestringThe current state of this database. For information about DB instance statuses, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/accessing-monitoring.html#Overview.DBInstance.Status">Viewing DB instance status</a> in the <i>Amazon RDS User Guide.</i>
db_namecorestringThe initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB.
db_parameter_groupscorejsonThe list of DB parameter groups applied to this DB instance.
db_security_groupscorejsonA list of DB security group elements containing <code>DBSecurityGroup.Name</code> and <code>DBSecurityGroup.Status</code> subelements.
db_subnet_groupcorejsonInformation about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
db_system_idcorestringThe Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is only valid for RDS Custom DB instances.
dbi_resource_idcorestringThe Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
dedicated_log_volumecoreboolIndicates whether the DB instance has a dedicated log volume (DLV) enabled.
deletion_protectioncoreboolIndicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html"> Deleting a DB Instance</a>.
domain_membershipscorejsonThe Active Directory Domain membership records associated with the DB instance.
enabled_cloudwatch_logs_exportscorearray<string>A list of log types that this DB instance is configured to export to CloudWatch Logs. Log types vary by DB engine. For information about the log types for each DB engine, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html">Monitoring Amazon RDS log files</a> in the <i>Amazon RDS User Guide.</i>
endpointcorejsonThe connection endpoint for the DB instance. <note> The endpoint might not be shown for instances with the status of <code>creating</code>. </note>
enginecorestringThe database engine used for this DB instance.
engine_lifecycle_supportcorestringThe life cycle type for the DB instance. For more information, see CreateDBInstance.
engine_versioncorestringThe version of the database engine.
enhanced_monitoring_resource_arncorestringThe Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
iam_database_authentication_enabledcoreboolIndicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance. For a list of engine versions that support IAM database authentication, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RDS_Fea_Regions_DB-eng.Feature.IamDatabaseAuthentication.html">IAM database authentication</a> in the <i>Amazon RDS User Guide</i> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.Aurora_Fea_Regions_DB-eng.Feature.IAMdbauth.html">IAM database authentication in Aurora</a> in the <i>Amazon Aurora User Guide</i>.
instance_create_timecoretimestampThe date and time when the DB instance was created.
iopscoreint64The Provisioned IOPS (I/O operations per second) value for the DB instance.
is_storage_config_upgrade_availablecoreboolIndicates whether an upgrade is recommended for the storage file system configuration on the DB instance. To migrate to the preferred configuration, you can either create a blue/green deployment, or create a read replica from the DB instance. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.UpgradeFileSystem">Upgrading the storage file system for a DB instance</a>.
kms_key_idcorestringIf <code>StorageEncrypted</code> is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
latest_restorable_timecoretimestampThe latest time to which a database in this DB instance can be restored with point-in-time restore.
license_modelcorestringThe license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
listener_endpointcorejsonThe listener connection endpoint for SQL Server Always On.
master_user_secretcorejsonThe secret managed by RDS in Amazon Web Services Secrets Manager for the master user password. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html">Password management with Amazon Web Services Secrets Manager</a> in the <i>Amazon RDS User Guide.</i>
master_usernamecorestringThe master username for the DB instance.
max_allocated_storagecoreint64The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
monitoring_intervalcoreint64The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
monitoring_role_arncorestringThe ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
multi_azcoreboolIndicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.
multi_tenantcoreboolSpecifies whether the DB instance is in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
nchar_character_set_namecorestringThe name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
network_typecorestringThe network type of the DB instance. Valid values: <ul> <li> <code>IPV4</code> </li> <li> <code>DUAL</code> </li> </ul> The network type is determined by the <code>DBSubnetGroup</code> specified for the DB instance. A <code>DBSubnetGroup</code> can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (<code>DUAL</code>). For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html"> Working with a DB instance in a VPC</a> in the <i>Amazon RDS User Guide</i> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html"> Working with a DB instance in a VPC</a> in the <i>Amazon Aurora User Guide.</i>
option_group_membershipscorejsonThe list of option group memberships for this DB instance.
pending_modified_valuescorejsonInformation about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.
percent_progresscorestringThe progress of the storage optimization operation as a percentage.
performance_insights_enabledcoreboolIndicates whether Performance Insights is enabled for the DB instance.
performance_insights_kms_key_idcorestringThe Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
performance_insights_retention_periodcoreint64The number of days to retain Performance Insights data. The default is 7 days. The following values are valid: <ul> <li> 7 </li> <li> <i>month</i> * 31, where <i>month</i> is a number of months from 1-23 </li> <li> 731 </li> </ul> For example, the following values are valid: <ul> <li> 93 (3 months * 31) </li> <li> 341 (11 months * 31) </li> <li> 589 (19 months * 31) </li> <li> 731 </li> </ul>
preferred_backup_windowcorestringThe daily time range during which automated backups are created if automated backups are enabled, as determined by the <code>BackupRetentionPeriod</code>.
preferred_maintenance_windowcorestringThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
processor_featurescorejsonThe number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
promotion_tiercoreint64The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance"> Fault Tolerance for an Aurora DB Cluster</a> in the <i>Amazon Aurora User Guide</i>.
publicly_accessiblecoreboolIndicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see <a>CreateDBInstance</a>.
read_replica_db_cluster_identifierscorearray<string>The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas. <note> Currently, each RDS DB instance can have only one Aurora read replica. </note>
read_replica_db_instance_identifierscorearray<string>The identifiers of the read replicas associated with this DB instance.
read_replica_source_db_cluster_identifiercorestringThe identifier of the source DB cluster if this DB instance is a read replica.
read_replica_source_db_instance_identifiercorestringThe identifier of the source DB instance if this DB instance is a read replica.
replica_modecorestringThe open mode of an Oracle read replica. The default is <code>open-read-only</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html">Working with Oracle Read Replicas for Amazon RDS</a> in the <i>Amazon RDS User Guide</i>. <note> This attribute is only supported in RDS for Oracle. </note>
resume_full_automation_mode_timecoretimestampThe number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
secondary_availability_zonecorestringIf present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
status_infoscorejsonThe status of a read replica. If the DB instance isn't a read replica, the value is blank.
storage_encryptedcoreboolIndicates whether the DB instance is encrypted.
storage_throughputcoreint64The storage throughput for the DB instance. This setting applies only to the <code>gp3</code> storage type.
storage_typecorestringThe storage type associated with the DB instance.
tagscorehstore
tde_credential_arncorestringThe ARN from the key store with which the instance is associated for TDE encryption.
timezonecorestringThe time zone of the DB instance. In most cases, the <code>Timezone</code> element is empty. <code>Timezone</code> content appears only for RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified.
vpc_security_groupscorejsonThe list of Amazon EC2 VPC security groups that the DB instance belongs to.