DBInstance (AWS Java SDK :: Services :: Amazon RDS 2.20.68 API)

java.lang.Object
- software.amazon.awssdk.services.rds.model.DBInstance

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DBInstance.Builder,DBInstance>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class DBInstance
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DBInstance.Builder,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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DBInstance.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DBInstance.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`activityStreamEngineNativeAuditFieldsIncluded()` Indicates whether engine-native audit fields are included in the database activity stream.
`String`	`activityStreamKinesisStreamName()` The name of the Amazon Kinesis data stream used for the database activity stream.
`String`	`activityStreamKmsKeyId()` The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
`ActivityStreamMode`	`activityStreamMode()` The mode of the database activity stream.
`String`	`activityStreamModeAsString()` The mode of the database activity stream.
`ActivityStreamPolicyStatus`	`activityStreamPolicyStatus()` The status of the policy state of the activity stream.
`String`	`activityStreamPolicyStatusAsString()` The status of the policy state of the activity stream.
`ActivityStreamStatus`	`activityStreamStatus()` The status of the database activity stream.
`String`	`activityStreamStatusAsString()` The status of the database activity stream.
`Integer`	`allocatedStorage()` Specifies the allocated storage size specified in gibibytes (GiB).
`List<DBInstanceRole>`	`associatedRoles()` The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
`Instant`	`automaticRestartTime()` The time when a stopped DB instance is restarted automatically.
`AutomationMode`	`automationMode()` The automation mode of the RDS Custom DB instance: `full` or `all paused`.
`String`	`automationModeAsString()` The automation mode of the RDS Custom DB instance: `full` or `all paused`.
`Boolean`	`autoMinorVersionUpgrade()` A value that indicates that minor version patches are applied automatically.
`String`	`availabilityZone()` Specifies the name of the Availability Zone the DB instance is located in.
`String`	`awsBackupRecoveryPointArn()` The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
`Integer`	`backupRetentionPeriod()` Specifies the number of days for which automatic DB snapshots are retained.
`String`	`backupTarget()` Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
`static DBInstance.Builder`	`builder()`
`String`	`caCertificateIdentifier()` The identifier of the CA certificate for this DB instance.
`CertificateDetails`	`certificateDetails()` The details of the DB instance's server certificate.
`String`	`characterSetName()` If present, specifies the name of the character set that this instance is associated with.
`Boolean`	`copyTagsToSnapshot()` Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
`Boolean`	`customerOwnedIpEnabled()` Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
`String`	`customIamInstanceProfile()` The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
`String`	`dbClusterIdentifier()` If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
`String`	`dbInstanceArn()` The Amazon Resource Name (ARN) for the DB instance.
`List<DBInstanceAutomatedBackupsReplication>`	`dbInstanceAutomatedBackupsReplications()` The list of replicated automated backups associated with the DB instance.
`String`	`dbInstanceClass()` Contains the name of the compute and memory capacity class of the DB instance.
`String`	`dbInstanceIdentifier()` Contains a user-supplied database identifier.
`Integer`	`dbInstancePort()` Specifies the port that the DB instance listens on.
`String`	`dbInstanceStatus()` Specifies the current state of this database.
`String`	`dbiResourceId()` The Amazon Web Services Region-unique, immutable identifier for the DB instance.
`String`	`dbName()` The meaning of this parameter differs according to the database engine you use.
`List<DBParameterGroupStatus>`	`dbParameterGroups()` Provides the list of DB parameter groups applied to this DB instance.
`List<DBSecurityGroupMembership>`	`dbSecurityGroups()` A list of DB security group elements containing `DBSecurityGroup.Name` and `DBSecurityGroup.Status` subelements.
`DBSubnetGroup`	`dbSubnetGroup()` Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
`String`	`dbSystemId()` The Oracle system ID (Oracle SID) for a container database (CDB).
`Boolean`	`deletionProtection()` Indicates if the DB instance has deletion protection enabled.
`List<DomainMembership>`	`domainMemberships()` The Active Directory Domain membership records associated with the DB instance.
`List<String>`	`enabledCloudwatchLogsExports()` A list of log types that this DB instance is configured to export to CloudWatch Logs.
`Endpoint`	`endpoint()` Specifies the connection endpoint.
`String`	`engine()` The name of the database engine to be used for this DB instance.
`String`	`engineVersion()` Indicates the database engine version.
`String`	`enhancedMonitoringResourceArn()` The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAssociatedRoles()` For responses, this returns true if the service returned a value for the AssociatedRoles property.
`boolean`	`hasDbInstanceAutomatedBackupsReplications()` For responses, this returns true if the service returned a value for the DBInstanceAutomatedBackupsReplications property.
`boolean`	`hasDbParameterGroups()` For responses, this returns true if the service returned a value for the DBParameterGroups property.
`boolean`	`hasDbSecurityGroups()` For responses, this returns true if the service returned a value for the DBSecurityGroups property.
`boolean`	`hasDomainMemberships()` For responses, this returns true if the service returned a value for the DomainMemberships property.
`boolean`	`hasEnabledCloudwatchLogsExports()` For responses, this returns true if the service returned a value for the EnabledCloudwatchLogsExports property.
`int`	`hashCode()`
`boolean`	`hasOptionGroupMemberships()` For responses, this returns true if the service returned a value for the OptionGroupMemberships property.
`boolean`	`hasProcessorFeatures()` For responses, this returns true if the service returned a value for the ProcessorFeatures property.
`boolean`	`hasReadReplicaDBClusterIdentifiers()` For responses, this returns true if the service returned a value for the ReadReplicaDBClusterIdentifiers property.
`boolean`	`hasReadReplicaDBInstanceIdentifiers()` For responses, this returns true if the service returned a value for the ReadReplicaDBInstanceIdentifiers property.
`boolean`	`hasStatusInfos()` For responses, this returns true if the service returned a value for the StatusInfos property.
`boolean`	`hasTagList()` For responses, this returns true if the service returned a value for the TagList property.
`boolean`	`hasVpcSecurityGroups()` For responses, this returns true if the service returned a value for the VpcSecurityGroups property.
`Boolean`	`iamDatabaseAuthenticationEnabled()` True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
`Instant`	`instanceCreateTime()` Provides the date and time the DB instance was created.
`Integer`	`iops()` Specifies the Provisioned IOPS (I/O operations per second) value.
`String`	`kmsKeyId()` If `StorageEncrypted` is true, the Amazon Web Services KMS key identifier for the encrypted DB instance.
`Instant`	`latestRestorableTime()` Specifies the latest time to which a database can be restored with point-in-time restore.
`String`	`licenseModel()` License model information for this DB instance.
`Endpoint`	`listenerEndpoint()` Specifies the listener connection endpoint for SQL Server Always On.
`String`	`masterUsername()` Contains the master username for the DB instance.
`MasterUserSecret`	`masterUserSecret()` Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
`Integer`	`maxAllocatedStorage()` The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
`Integer`	`monitoringInterval()` The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
`String`	`monitoringRoleArn()` The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
`Boolean`	`multiAZ()` Specifies if the DB instance is a Multi-AZ deployment.
`String`	`ncharCharacterSetName()` The name of the NCHAR character set for the Oracle DB instance.
`String`	`networkType()` The network type of the DB instance.
`List<OptionGroupMembership>`	`optionGroupMemberships()` Provides the list of option group memberships for this DB instance.
`PendingModifiedValues`	`pendingModifiedValues()` A value that specifies that changes to the DB instance are pending.
`Boolean`	`performanceInsightsEnabled()` True if Performance Insights is enabled for the DB instance, and otherwise false.
`String`	`performanceInsightsKMSKeyId()` The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
`Integer`	`performanceInsightsRetentionPeriod()` The number of days to retain Performance Insights data.
`String`	`preferredBackupWindow()` Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`.
`String`	`preferredMaintenanceWindow()` Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`List<ProcessorFeature>`	`processorFeatures()` The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
`Integer`	`promotionTier()` A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.
`Boolean`	`publiclyAccessible()` Specifies the accessibility options for the DB instance.
`List<String>`	`readReplicaDBClusterIdentifiers()` Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.
`List<String>`	`readReplicaDBInstanceIdentifiers()` Contains one or more identifiers of the read replicas associated with this DB instance.
`String`	`readReplicaSourceDBClusterIdentifier()` Contains the identifier of the source DB cluster if this DB instance is a read replica.
`String`	`readReplicaSourceDBInstanceIdentifier()` Contains the identifier of the source DB instance if this DB instance is a read replica.
`ReplicaMode`	`replicaMode()` The open mode of an Oracle read replica.
`String`	`replicaModeAsString()` The open mode of an Oracle read replica.
`Instant`	`resumeFullAutomationModeTime()` The number of minutes to pause the automation.
`List<SdkField<?>>`	`sdkFields()`
`String`	`secondaryAvailabilityZone()` If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
`static Class<? extends DBInstance.Builder>`	`serializableBuilderClass()`
`List<DBInstanceStatusInfo>`	`statusInfos()` The status of a read replica.
`Boolean`	`storageEncrypted()` Specifies whether the DB instance is encrypted.
`Integer`	`storageThroughput()` Specifies the storage throughput for the DB instance.
`String`	`storageType()` Specifies the storage type associated with the DB instance.
`List<Tag>`	`tagList()` Returns the value of the TagList property for this object.
`String`	`tdeCredentialArn()` The ARN from the key store with which the instance is associated for TDE encryption.
`String`	`timezone()` The time zone of the DB instance.
`DBInstance.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<VpcSecurityGroupMembership>`	`vpcSecurityGroups()` Provides a list of VPC security group elements that the DB instance belongs to.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - dbInstanceIdentifier
```
public final String dbInstanceIdentifier()
```
    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
    
    Returns:
    
    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
  - dbInstanceClass
```
public final String dbInstanceClass()
```
    Contains the name of the compute and memory capacity class of the DB instance.
    
    Returns:
    
    Contains the name of the compute and memory capacity class of the DB instance.
  - engine
```
public final String engine()
```
    The name of the database engine to be used for this DB instance.
    
    Returns:
    
    The name of the database engine to be used for this DB instance.
  - dbInstanceStatus
```
public final String dbInstanceStatus()
```
    Specifies the current state of this database.
    
    For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
    
    Returns:
    
    Specifies the current state of this database.
    
    For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
  - automaticRestartTime
```
public final Instant automaticRestartTime()
```
    The time when a stopped DB instance is restarted automatically.
    
    Returns:
    
    The time when a stopped DB instance is restarted automatically.
  - masterUsername
```
public final String masterUsername()
```
    Contains the master username for the DB instance.
    
    Returns:
    
    Contains the master username for the DB instance.
  - dbName
```
public final String dbName()
```
    The meaning of this parameter differs according to the database engine you use.
    
    MySQL, MariaDB, SQL Server, PostgreSQL
    
    Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
    
    Type: String
    
    Oracle
    
    Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
    
    Returns:
    
    The meaning of this parameter differs according to the database engine you use.
    
    MySQL, MariaDB, SQL Server, PostgreSQL
    
    Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
    
    Type: String
    
    Oracle
    
    Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
  - endpoint
```
public final Endpoint endpoint()
```
    Specifies the connection endpoint.
    
    The endpoint might not be shown for instances whose status is creating.
    
    Returns:
    
    Specifies the connection endpoint.
    
    The endpoint might not be shown for instances whose status is creating.
  - allocatedStorage
```
public final Integer allocatedStorage()
```
    Specifies the allocated storage size specified in gibibytes (GiB).
    
    Returns:
    
    Specifies the allocated storage size specified in gibibytes (GiB).
  - instanceCreateTime
```
public final Instant instanceCreateTime()
```
    Provides the date and time the DB instance was created.
    
    Returns:
    
    Provides the date and time the DB instance was created.
  - preferredBackupWindow
```
public final String preferredBackupWindow()
```
    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
    
    Returns:
    
    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
  - backupRetentionPeriod
```
public final Integer backupRetentionPeriod()
```
    Specifies the number of days for which automatic DB snapshots are retained.
    
    Returns:
    
    Specifies the number of days for which automatic DB snapshots are retained.
  - hasDbSecurityGroups
```
public final boolean hasDbSecurityGroups()
```
    For responses, this returns true if the service returned a value for the DBSecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - dbSecurityGroups
```
public final List<DBSecurityGroupMembership> dbSecurityGroups()
```
    A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDbSecurityGroups() method.
    
    Returns:
    
    A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
  - hasVpcSecurityGroups
```
public final boolean hasVpcSecurityGroups()
```
    For responses, this returns true if the service returned a value for the VpcSecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - vpcSecurityGroups
```
public final List<VpcSecurityGroupMembership> vpcSecurityGroups()
```
    Provides a list of VPC security group elements that the DB instance belongs to.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVpcSecurityGroups() method.
    
    Returns:
    
    Provides a list of VPC security group elements that the DB instance belongs to.
  - hasDbParameterGroups
```
public final boolean hasDbParameterGroups()
```
    For responses, this returns true if the service returned a value for the DBParameterGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - dbParameterGroups
```
public final List<DBParameterGroupStatus> dbParameterGroups()
```
    Provides the list of DB parameter groups applied to this DB instance.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDbParameterGroups() method.
    
    Returns:
    
    Provides the list of DB parameter groups applied to this DB instance.
  - availabilityZone
```
public final String availabilityZone()
```
    Specifies the name of the Availability Zone the DB instance is located in.
    
    Returns:
    
    Specifies the name of the Availability Zone the DB instance is located in.
  - dbSubnetGroup
```
public final DBSubnetGroup dbSubnetGroup()
```
    Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
    
    Returns:
    
    Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
  - preferredMaintenanceWindow
```
public final String preferredMaintenanceWindow()
```
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    
    Returns:
    
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
  - pendingModifiedValues
```
public final PendingModifiedValues pendingModifiedValues()
```
    A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
    
    Returns:
    
    A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
  - latestRestorableTime
```
public final Instant latestRestorableTime()
```
    Specifies the latest time to which a database can be restored with point-in-time restore.
    
    Returns:
    
    Specifies the latest time to which a database can be restored with point-in-time restore.
  - multiAZ
```
public final Boolean multiAZ()
```
    Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
    
    Returns:
    
    Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
  - engineVersion
```
public final String engineVersion()
```
    Indicates the database engine version.
    
    Returns:
    
    Indicates the database engine version.
  - autoMinorVersionUpgrade
```
public final Boolean autoMinorVersionUpgrade()
```
    A value that indicates that minor version patches are applied automatically.
    
    Returns:
    
    A value that indicates that minor version patches are applied automatically.
  - readReplicaSourceDBInstanceIdentifier
```
public final String readReplicaSourceDBInstanceIdentifier()
```
    Contains the identifier of the source DB instance if this DB instance is a read replica.
    
    Returns:
    
    Contains the identifier of the source DB instance if this DB instance is a read replica.
  - hasReadReplicaDBInstanceIdentifiers
```
public final boolean hasReadReplicaDBInstanceIdentifiers()
```
    For responses, this returns true if the service returned a value for the ReadReplicaDBInstanceIdentifiers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - readReplicaDBInstanceIdentifiers
```
public final List<String> readReplicaDBInstanceIdentifiers()
```
    Contains one or more identifiers of the read replicas associated with this DB instance.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasReadReplicaDBInstanceIdentifiers() method.
    
    Returns:
    
    Contains one or more identifiers of the read replicas associated with this DB instance.
  - hasReadReplicaDBClusterIdentifiers
```
public final boolean hasReadReplicaDBClusterIdentifiers()
```
    For responses, this returns true if the service returned a value for the ReadReplicaDBClusterIdentifiers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - readReplicaDBClusterIdentifiers
```
public final List<String> readReplicaDBClusterIdentifiers()
```
    Contains one or more 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.
    
    Currently, each RDS DB instance can have only one Aurora read replica.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasReadReplicaDBClusterIdentifiers() method.
    
    Returns:
    
    Contains one or more 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.
    
    Currently, each RDS DB instance can have only one Aurora read replica.
  - replicaMode
```
public final ReplicaMode 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.
    
    This attribute is only supported in RDS for Oracle.
    
    If the service returns an enum value that is not available in the current SDK version, replicaMode will return ReplicaMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from replicaModeAsString().
    
    Returns:
    
    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.
    
    This attribute is only supported in RDS for Oracle.
    
    See Also:
    
    ReplicaMode
  - replicaModeAsString
```
public final String replicaModeAsString()
```
    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.
    
    This attribute is only supported in RDS for Oracle.
    
    If the service returns an enum value that is not available in the current SDK version, replicaMode will return ReplicaMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from replicaModeAsString().
    
    Returns:
    
    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.
    
    This attribute is only supported in RDS for Oracle.
    
    See Also:
    
    ReplicaMode
  - licenseModel
```
public final String licenseModel()
```
    License model information for this DB instance. This setting doesn't apply to RDS Custom.
    
    Returns:
    
    License model information for this DB instance. This setting doesn't apply to RDS Custom.
  - iops
```
public final Integer iops()
```
    Specifies the Provisioned IOPS (I/O operations per second) value.
    
    Returns:
    
    Specifies the Provisioned IOPS (I/O operations per second) value.
  - hasOptionGroupMemberships
```
public final boolean hasOptionGroupMemberships()
```
    For responses, this returns true if the service returned a value for the OptionGroupMemberships property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - optionGroupMemberships
```
public final List<OptionGroupMembership> optionGroupMemberships()
```
    Provides the list of option group memberships for this DB instance.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOptionGroupMemberships() method.
    
    Returns:
    
    Provides the list of option group memberships for this DB instance.
  - characterSetName
```
public final String characterSetName()
```
    If present, specifies the name of the character set that this instance is associated with.
    
    Returns:
    
    If present, specifies the name of the character set that this instance is associated with.
  - ncharCharacterSetName
```
public final String 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.
    
    Returns:
    
    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.
  - secondaryAvailabilityZone
```
public final String secondaryAvailabilityZone()
```
    If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
    
    Returns:
    
    If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
  - publiclyAccessible
```
public final Boolean publiclyAccessible()
```
    Specifies the accessibility options for the DB instance.
    
    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.
    
    Returns:
    
    Specifies the accessibility options for the DB instance.
    
    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.
  - hasStatusInfos
```
public final boolean hasStatusInfos()
```
    For responses, this returns true if the service returned a value for the StatusInfos property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - statusInfos
```
public final List<DBInstanceStatusInfo> statusInfos()
```
    The status of a read replica. If the instance isn't a read replica, this is blank.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStatusInfos() method.
    
    Returns:
    
    The status of a read replica. If the instance isn't a read replica, this is blank.
  - storageType
```
public final String storageType()
```
    Specifies the storage type associated with the DB instance.
    
    Returns:
    
    Specifies the storage type associated with the DB instance.
  - tdeCredentialArn
```
public final String tdeCredentialArn()
```
    The ARN from the key store with which the instance is associated for TDE encryption.
    
    Returns:
    
    The ARN from the key store with which the instance is associated for TDE encryption.
  - dbInstancePort
```
public final Integer dbInstancePort()
```
    Specifies 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.
    
    Returns:
    
    Specifies 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.
  - dbClusterIdentifier
```
public final String dbClusterIdentifier()
```
    If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
    
    Returns:
    
    If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
  - storageEncrypted
```
public final Boolean storageEncrypted()
```
    Specifies whether the DB instance is encrypted.
    
    Returns:
    
    Specifies whether the DB instance is encrypted.
  - kmsKeyId
```
public final String kmsKeyId()
```
    If StorageEncrypted is true, 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.
    
    Returns:
    
    If StorageEncrypted is true, 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.
  - dbiResourceId
```
public final String 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.
    
    Returns:
    
    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.
  - caCertificateIdentifier
```
public final String 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.
    
    Returns:
    
    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.
  - hasDomainMemberships
```
public final boolean hasDomainMemberships()
```
    For responses, this returns true if the service returned a value for the DomainMemberships property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - domainMemberships
```
public final List<DomainMembership> domainMemberships()
```
    The Active Directory Domain membership records associated with the DB instance.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDomainMemberships() method.
    
    Returns:
    
    The Active Directory Domain membership records associated with the DB instance.
  - copyTagsToSnapshot
```
public final Boolean copyTagsToSnapshot()
```
    Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
    
    Amazon Aurora
    
    Not applicable. 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.
    
    Returns:
    
    Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
    
    Amazon Aurora
    
    Not applicable. 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.
  - monitoringInterval
```
public final Integer monitoringInterval()
```
    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
    
    Returns:
    
    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
  - enhancedMonitoringResourceArn
```
public final String enhancedMonitoringResourceArn()
```
    The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
  - monitoringRoleArn
```
public final String monitoringRoleArn()
```
    The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
    
    Returns:
    
    The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
  - promotionTier
```
public final Integer promotionTier()
```
    A value that specifies the order 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.
    
    Returns:
    
    A value that specifies the order 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.
  - dbInstanceArn
```
public final String dbInstanceArn()
```
    The Amazon Resource Name (ARN) for the DB instance.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the DB instance.
  - timezone
```
public final String 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.
    
    Returns:
    
    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.
  - iamDatabaseAuthenticationEnabled
```
public final Boolean iamDatabaseAuthenticationEnabled()
```
    True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
    
    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.
    
    Returns:
    
    True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
    
    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.
  - performanceInsightsEnabled
```
public final Boolean performanceInsightsEnabled()
```
    True if Performance Insights is enabled for the DB instance, and otherwise false.
    
    Returns:
    
    True if Performance Insights is enabled for the DB instance, and otherwise false.
  - performanceInsightsKMSKeyId
```
public final String 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.
    
    Returns:
    
    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.
  - performanceInsightsRetentionPeriod
```
public final Integer performanceInsightsRetentionPeriod()
```
    The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
    - 7
    - month * 31, where month is a number of months from 1-23
    - 731
    For example, the following values are valid:
    - 93 (3 months * 31)
    - 341 (11 months * 31)
    - 589 (19 months * 31)
    - 731
    Returns:
    The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
    
    7
    
    month * 31, where month is a number of months from 1-23
    
    731
    
    For example, the following values are valid:
    
    93 (3 months * 31)
    
    341 (11 months * 31)
    
    589 (19 months * 31)
    
    731
  - hasEnabledCloudwatchLogsExports
```
public final boolean hasEnabledCloudwatchLogsExports()
```
    For responses, this returns true if the service returned a value for the EnabledCloudwatchLogsExports property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - enabledCloudwatchLogsExports
```
public final List<String> 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 Amazon RDS Database Log Files in the Amazon RDS User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEnabledCloudwatchLogsExports() method.
    
    Returns:
    
    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 Amazon RDS Database Log Files in the Amazon RDS User Guide.
  - hasProcessorFeatures
```
public final boolean hasProcessorFeatures()
```
    For responses, this returns true if the service returned a value for the ProcessorFeatures property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - processorFeatures
```
public final List<ProcessorFeature> processorFeatures()
```
    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasProcessorFeatures() method.
    
    Returns:
    
    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
  - deletionProtection
```
public final Boolean deletionProtection()
```
    Indicates if 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.
    
    Returns:
    
    Indicates if 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.
  - hasAssociatedRoles
```
public final boolean hasAssociatedRoles()
```
    For responses, this returns true if the service returned a value for the AssociatedRoles property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - associatedRoles
```
public final List<DBInstanceRole> associatedRoles()
```
    The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAssociatedRoles() method.
    
    Returns:
    
    The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
  - listenerEndpoint
```
public final Endpoint listenerEndpoint()
```
    Specifies the listener connection endpoint for SQL Server Always On.
    
    Returns:
    
    Specifies the listener connection endpoint for SQL Server Always On.
  - maxAllocatedStorage
```
public final Integer maxAllocatedStorage()
```
    The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
    
    Returns:
    
    The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
  - hasTagList
```
public final boolean hasTagList()
```
    For responses, this returns true if the service returned a value for the TagList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tagList
```
public final List<Tag> tagList()
```
    Returns the value of the TagList property for this object.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagList() method.
    
    Returns:
    
    The value of the TagList property for this object.
  - hasDbInstanceAutomatedBackupsReplications
```
public final boolean hasDbInstanceAutomatedBackupsReplications()
```
    For responses, this returns true if the service returned a value for the DBInstanceAutomatedBackupsReplications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - dbInstanceAutomatedBackupsReplications
```
public final List<DBInstanceAutomatedBackupsReplication> dbInstanceAutomatedBackupsReplications()
```
    The list of replicated automated backups associated with the DB instance.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDbInstanceAutomatedBackupsReplications() method.
    
    Returns:
    
    The list of replicated automated backups associated with the DB instance.
  - customerOwnedIpEnabled
```
public final Boolean customerOwnedIpEnabled()
```
    Specifies 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.
    
    Returns:
    
    Specifies 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.
  - awsBackupRecoveryPointArn
```
public final String awsBackupRecoveryPointArn()
```
    The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
  - activityStreamStatus
```
public final ActivityStreamStatus activityStreamStatus()
```
    The status of the database activity stream.
    
    If the service returns an enum value that is not available in the current SDK version, activityStreamStatus will return ActivityStreamStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from activityStreamStatusAsString().
    
    Returns:
    
    The status of the database activity stream.
    
    See Also:
    
    ActivityStreamStatus
  - activityStreamStatusAsString
```
public final String activityStreamStatusAsString()
```
    The status of the database activity stream.
    
    If the service returns an enum value that is not available in the current SDK version, activityStreamStatus will return ActivityStreamStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from activityStreamStatusAsString().
    
    Returns:
    
    The status of the database activity stream.
    
    See Also:
    
    ActivityStreamStatus
  - activityStreamKmsKeyId
```
public final String 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.
    
    Returns:
    
    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.
  - activityStreamKinesisStreamName
```
public final String activityStreamKinesisStreamName()
```
    The name of the Amazon Kinesis data stream used for the database activity stream.
    
    Returns:
    
    The name of the Amazon Kinesis data stream used for the database activity stream.
  - activityStreamMode
```
public final ActivityStreamMode 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.
    
    If the service returns an enum value that is not available in the current SDK version, activityStreamMode will return ActivityStreamMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from activityStreamModeAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    ActivityStreamMode
  - activityStreamModeAsString
```
public final String activityStreamModeAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, activityStreamMode will return ActivityStreamMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from activityStreamModeAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    ActivityStreamMode
  - activityStreamEngineNativeAuditFieldsIncluded
```
public final Boolean activityStreamEngineNativeAuditFieldsIncluded()
```
    Indicates whether engine-native audit fields are included in the database activity stream.
    
    Returns:
    
    Indicates whether engine-native audit fields are included in the database activity stream.
  - automationMode
```
public final AutomationMode 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.
    
    If the service returns an enum value that is not available in the current SDK version, automationMode will return AutomationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from automationModeAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    AutomationMode
  - automationModeAsString
```
public final String automationModeAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, automationMode will return AutomationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from automationModeAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    AutomationMode
  - resumeFullAutomationModeTime
```
public final Instant 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.
    
    Returns:
    
    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.
  - customIamInstanceProfile
```
public final String 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.
    Returns:
    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.
  - backupTarget
```
public final String backupTarget()
```
    Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
    
    Returns:
    
    Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
  - networkType
```
public final String networkType()
```
    The network type of the DB instance.
    
    Valid values:
    - IPV4
    - DUAL
    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.
    Returns:
    The network type of the DB instance.
    
    Valid values:
    
    IPV4
    
    DUAL
    
    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.
  - activityStreamPolicyStatus
```
public final ActivityStreamPolicyStatus activityStreamPolicyStatus()
```
    The status of the policy state of the activity stream.
    
    If the service returns an enum value that is not available in the current SDK version, activityStreamPolicyStatus will return ActivityStreamPolicyStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from activityStreamPolicyStatusAsString().
    
    Returns:
    
    The status of the policy state of the activity stream.
    
    See Also:
    
    ActivityStreamPolicyStatus
  - activityStreamPolicyStatusAsString
```
public final String activityStreamPolicyStatusAsString()
```
    The status of the policy state of the activity stream.
    
    If the service returns an enum value that is not available in the current SDK version, activityStreamPolicyStatus will return ActivityStreamPolicyStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from activityStreamPolicyStatusAsString().
    
    Returns:
    
    The status of the policy state of the activity stream.
    
    See Also:
    
    ActivityStreamPolicyStatus
  - storageThroughput
```
public final Integer storageThroughput()
```
    Specifies the storage throughput for the DB instance.
    
    This setting applies only to the gp3 storage type.
    
    Returns:
    
    Specifies the storage throughput for the DB instance.
    
    This setting applies only to the gp3 storage type.
  - dbSystemId
```
public final String 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 valid for RDS Custom only.
    
    Returns:
    
    The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is valid for RDS Custom only.
  - masterUserSecret
```
public final MasterUserSecret masterUserSecret()
```
    Contains 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.
    
    Returns:
    
    Contains 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.
  - certificateDetails
```
public final CertificateDetails certificateDetails()
```
    The details of the DB instance's server certificate.
    
    Returns:
    
    The details of the DB instance's server certificate.
  - readReplicaSourceDBClusterIdentifier
```
public final String readReplicaSourceDBClusterIdentifier()
```
    Contains the identifier of the source DB cluster if this DB instance is a read replica.
    
    Returns:
    
    Contains the identifier of the source DB cluster if this DB instance is a read replica.
  - toBuilder
```
public DBInstance.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DBInstance.Builder,DBInstance>
  - builder
```
public static DBInstance.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DBInstance.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DBInstance

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

dbInstanceIdentifier

dbInstanceClass

engine

dbInstanceStatus

automaticRestartTime

masterUsername

dbName

endpoint

allocatedStorage

instanceCreateTime

preferredBackupWindow

backupRetentionPeriod

hasDbSecurityGroups

dbSecurityGroups

hasVpcSecurityGroups

vpcSecurityGroups

hasDbParameterGroups

dbParameterGroups

availabilityZone

dbSubnetGroup

preferredMaintenanceWindow

pendingModifiedValues

latestRestorableTime

multiAZ

engineVersion

autoMinorVersionUpgrade

readReplicaSourceDBInstanceIdentifier

hasReadReplicaDBInstanceIdentifiers

readReplicaDBInstanceIdentifiers

hasReadReplicaDBClusterIdentifiers

readReplicaDBClusterIdentifiers

replicaMode

replicaModeAsString

licenseModel

iops

hasOptionGroupMemberships

optionGroupMemberships

characterSetName

ncharCharacterSetName

secondaryAvailabilityZone

publiclyAccessible

hasStatusInfos

statusInfos

storageType

tdeCredentialArn

dbInstancePort

dbClusterIdentifier

storageEncrypted

kmsKeyId

dbiResourceId

caCertificateIdentifier

hasDomainMemberships

domainMemberships

copyTagsToSnapshot

monitoringInterval

enhancedMonitoringResourceArn

monitoringRoleArn

promotionTier

dbInstanceArn

timezone

iamDatabaseAuthenticationEnabled

performanceInsightsEnabled

performanceInsightsKMSKeyId

performanceInsightsRetentionPeriod

hasEnabledCloudwatchLogsExports

enabledCloudwatchLogsExports

hasProcessorFeatures

processorFeatures

deletionProtection

hasAssociatedRoles

associatedRoles

listenerEndpoint

maxAllocatedStorage

hasTagList