DBInstance

Gets and sets the property ActivityStreamEngineNativeAuditFieldsIncluded.

Indicates whether engine-native audit fields are included in the database activity stream.

Gets and sets the property ActivityStreamKinesisStreamName.

The name of the Amazon Kinesis data stream used for the database activity stream.

Gets and sets the property ActivityStreamKmsKeyId.

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.

Gets and sets the property ActivityStreamMode.

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.

Gets and sets the property ActivityStreamPolicyStatus.

The status of the policy state of the activity stream.

Gets and sets the property ActivityStreamStatus.

The status of the database activity stream.

Gets and sets the property AllocatedStorage.

The amount of storage in gibibytes (GiB) allocated for the DB instance.

Gets and sets the property AssociatedRoles.

The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

Gets and sets the property AutomaticRestartTime.

The time when a stopped DB instance is restarted automatically.

Gets and sets the property AutomationMode.

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.

Gets and sets the property AutoMinorVersionUpgrade.

Indicates whether minor version patches are applied automatically.

Gets and sets the property AvailabilityZone.

The name of the Availability Zone where the DB instance is located.

Gets and sets the property AwsBackupRecoveryPointArn.

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

Gets and sets the property BackupRetentionPeriod.

The number of days for which automatic DB snapshots are retained.

Gets and sets the property BackupTarget.

The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

Gets and sets the property CACertificateIdentifier.

The identifier of the CA certificate for this DB instance.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

Gets and sets the property CertificateDetails.

The details of the DB instance's server certificate.

Gets and sets the property CharacterSetName.

If present, specifies the name of the character set that this instance is associated with.

Gets and sets the property CopyTagsToSnapshot.

Indicates 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 DBCluster.

Gets and sets the property CustomerOwnedIpEnabled.

Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

A CoIP 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 Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

Gets and sets the property CustomIamInstanceProfile.

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 profile must exist in your account.

• The profile must have an IAM role that Amazon EC2 has permissions to assume.

• The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

Gets and sets the property DBClusterIdentifier.

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.

Gets and sets the property DBInstanceArn.

The Amazon Resource Name (ARN) for the DB instance.

Gets and sets the property DBInstanceAutomatedBackupsReplications.

The list of replicated automated backups associated with the DB instance.

Gets and sets the property DBInstanceClass.

The name of the compute and memory capacity class of the DB instance.

Gets and sets the property DBInstanceIdentifier.

The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

Gets and sets the property DbInstancePort.

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.

Gets and sets the property DBInstanceStatus.

The current state of this database.

For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.

Gets and sets the property DbiResourceId.

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.

Gets and sets the property DBName.

The 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.

Gets and sets the property DBParameterGroups.

The list of DB parameter groups applied to this DB instance.

Gets and sets the property DBSecurityGroups.

A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

Gets and sets the property DBSubnetGroup.

Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

Gets and sets the property DBSystemId.

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.

Gets and sets the property DedicatedLogVolume.

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

Gets and sets the property DeletionProtection.

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.

Gets and sets the property DomainMemberships.

The Active Directory Domain membership records associated with the DB instance.

Gets and sets the property EnabledCloudwatchLogsExports.

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 Monitoring Amazon RDS log files in the Amazon RDS User Guide.

Gets and sets the property Endpoint.

The connection endpoint for the DB instance.

Gets and sets the property Engine.

The database engine used for this DB instance.

Gets and sets the property EngineVersion.

The version of the database engine.

Gets and sets the property EnhancedMonitoringResourceArn.

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

Gets and sets the property IAMDatabaseAuthenticationEnabled.

Indicates 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 IAM database authentication in the Amazon RDS User Guide and IAM database authentication in Aurora in the Amazon Aurora User Guide.

Gets and sets the property InstanceCreateTime.

The date and time when the DB instance was created.

Gets and sets the property Iops.

The Provisioned IOPS (I/O operations per second) value for the DB instance.

Gets and sets the property IsStorageConfigUpgradeAvailable.

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.

Gets and sets the property KmsKeyId.

If StorageEncrypted 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.

Gets and sets the property LatestRestorableTime.

The latest time to which a database in this DB instance can be restored with point-in-time restore.

Gets and sets the property LicenseModel.

The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.

Gets and sets the property ListenerEndpoint.

The listener connection endpoint for SQL Server Always On.

Gets and sets the property MasterUsername.

The master username for the DB instance.

Gets and sets the property MasterUserSecret.

The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.

Gets and sets the property MaxAllocatedStorage.

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

Gets and sets the property MonitoringInterval.

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

Gets and sets the property MonitoringRoleArn.

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

Gets and sets the property MultiAZ.

Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.

Gets and sets the property MultiTenant.

Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

Gets and sets the property NcharCharacterSetName.

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.

Gets and sets the property NetworkType.

The network type of the DB instance.

The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.

Valid Values: IPV4 | DUAL

Gets and sets the property OptionGroupMemberships.

The list of option group memberships for this DB instance.

Gets and sets the property PendingModifiedValues.

Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.

Gets and sets the property PercentProgress.

The progress of the storage optimization operation as a percentage.

Gets and sets the property PerformanceInsightsEnabled.

Indicates whether Performance Insights is enabled for the DB instance.

Gets and sets the property PerformanceInsightsKMSKeyId.

The 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.

Gets and sets the property PerformanceInsightsRetentionPeriod.

The number of days to retain Performance Insights data.

Valid Values:

• 7

• month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

• 731

Default: 7 days

Gets and sets the property PreferredBackupWindow.

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Gets and sets the property PreferredMaintenanceWindow.

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Gets and sets the property ProcessorFeatures.

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Gets and sets the property PromotionTier.

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.

Gets and sets the property PubliclyAccessible.

Indicates whether the DB instance is publicly accessible.

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. 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 CreateDBInstance.

Gets and sets the property ReadReplicaDBClusterIdentifiers.

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.

Gets and sets the property ReadReplicaDBInstanceIdentifiers.

The identifiers of the read replicas associated with this DB instance.

Gets and sets the property ReadReplicaSourceDBClusterIdentifier.

The identifier of the source DB cluster if this DB instance is a read replica.

Gets and sets the property ReadReplicaSourceDBInstanceIdentifier.

The identifier of the source DB instance if this DB instance is a read replica.

Gets and sets the property ReplicaMode.

The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

Gets and sets the property ResumeFullAutomationModeTime.

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.

Gets and sets the property SecondaryAvailabilityZone.

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

Gets and sets the property StatusInfos.

The status of a read replica. If the DB instance isn't a read replica, the value is blank.

Gets and sets the property StorageEncrypted.

Indicates whether the DB instance is encrypted.

Gets and sets the property StorageThroughput.

The storage throughput for the DB instance.

This setting applies only to the gp3 storage type.

Gets and sets the property StorageType.

The storage type associated with the DB instance.

Gets and sets the property TagList.

Gets and sets the property TdeCredentialArn.

The ARN from the key store with which the instance is associated for TDE encryption.

Gets and sets the property Timezone.

The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

Gets and sets the property VpcSecurityGroups.

The list of Amazon EC2 VPC security groups that the DB instance belongs to.