DbInstance
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations CreateDBInstance, CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance, PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.
Types
Properties
Indicates whether engine-native audit fields are included in the database activity stream.
The name of the Amazon Kinesis data stream used for the database activity stream.
The 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.
The 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.
The status of the policy state of the activity stream.
The status of the database activity stream.
The amount of storage in gibibytes (GiB) allocated for the DB instance.
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
The time when a stopped DB instance is restarted automatically.
The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.
Indicates whether minor version patches are applied automatically.
The name of the Availability Zone where the DB instance is located.
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
The number of days for which automatic DB snapshots are retained.
The location where automated backups and manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.
The identifier of the CA certificate for this DB instance.
The details of the DB instance's server certificate.
If present, specifies the name of the character set that this instance is associated with.
Indicates whether tags are copied from the DB instance to snapshots of the DB instance.
Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
The mode of Database Insights that is enabled for the instance.
If 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.
The Amazon Resource Name (ARN) for the DB instance.
The list of replicated automated backups associated with the DB instance.
The name of the compute and memory capacity class of the DB instance.
The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
The 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.
The current state of this database.
The 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.
The list of DB parameter groups applied to this DB instance.
A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
The 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.
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.
The Active Directory Domain membership records associated with the DB instance.
A list of log types that this DB instance is configured to export to CloudWatch Logs.
The lifecycle type for the DB instance.
The version of the database engine.
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance.
The date and time when the DB instance was created.
Indicates 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 Upgrading the storage file system for a DB instance.
The latest time to which a database in this DB instance can be restored with point-in-time restore.
The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
The listener connection endpoint for SQL Server Always On.
The master username for the DB instance.
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
The 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.
The network type of the DB instance.
The list of option group memberships for this DB instance.
Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.
The progress of the storage optimization operation as a percentage.
Indicates whether Performance Insights is enabled for the DB instance.
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The number of days to retain Performance Insights data.
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
The 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 Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
Indicates whether the DB instance is publicly accessible.
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.
The identifiers of the read replicas associated with this DB instance.
The identifier of the source DB cluster if this DB instance is a read replica.
The identifier of the source DB instance if this DB instance is a read replica.
The open mode of a Db2 or an Oracle read replica. The default is open-read-only. For more information, see Working with read replicas for Amazon RDS for Db2 and Working with read replicas for Amazon RDS for Oracle in the Amazon RDS User Guide.
The 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.
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
The status of a read replica. If the DB instance isn't a read replica, the value is blank.
Indicates whether the DB instance is encrypted.
The storage throughput for the DB instance.
The storage type associated with the DB instance.
The ARN from the key store with which the instance is associated for TDE encryption.
The list of Amazon EC2 VPC security groups that the DB instance belongs to.