DBInstance (AWS Java SDK :: Services :: Amazon RDS 2.16.92 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 DescribeDBInstances action.

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.
`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.
`List<DBInstanceRole>`	`associatedRoles()` The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
`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.
`static DBInstance.Builder`	`builder()`
`String`	`caCertificateIdentifier()` The identifier of the CA certificate for this DB instance.
`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`	`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.
`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()` Returns true if the AssociatedRoles property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasDbInstanceAutomatedBackupsReplications()` Returns true if the DBInstanceAutomatedBackupsReplications property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasDbParameterGroups()` Returns true if the DBParameterGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasDbSecurityGroups()` Returns true if the DBSecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasDomainMemberships()` Returns true if the DomainMemberships property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasEnabledCloudwatchLogsExports()` Returns true if the EnabledCloudwatchLogsExports property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasOptionGroupMemberships()` Returns true if the OptionGroupMemberships property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasProcessorFeatures()` Returns true if the ProcessorFeatures property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasReadReplicaDBClusterIdentifiers()` Returns true if the ReadReplicaDBClusterIdentifiers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasReadReplicaDBInstanceIdentifiers()` Returns true if the ReadReplicaDBInstanceIdentifiers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasStatusInfos()` Returns true if the StatusInfos property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTagList()` Returns true if the TagList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasVpcSecurityGroups()` Returns true if the VpcSecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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.
`Integer`	`maxAllocatedStorage()` The upper limit 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.
`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 amount of time, in 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`	`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.
`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.
`String`	`storageType()` Specifies the storage type associated with 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.
  - 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.
    
    Returns:
    
    Specifies the connection endpoint.
  - allocatedStorage
```
public final Integer allocatedStorage()
```
    Specifies the allocated storage size specified in gibibytes.
    
    Returns:
    
    Specifies the allocated storage size specified in gibibytes.
  - 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()
```
    Returns true if the DBSecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasDbSecurityGroups() to see if a value was sent in this field.
    
    Returns:
    
    A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
  - hasVpcSecurityGroups
```
public final boolean hasVpcSecurityGroups()
```
    Returns true if the VpcSecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasVpcSecurityGroups() to see if a value was sent in this field.
    
    Returns:
    
    Provides a list of VPC security group elements that the DB instance belongs to.
  - hasDbParameterGroups
```
public final boolean hasDbParameterGroups()
```
    Returns true if the DBParameterGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasDbParameterGroups() to see if a value was sent in this field.
    
    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.
    
    Returns:
    
    Specifies if the DB instance is a Multi-AZ deployment.
  - 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()
```
    Returns true if the ReadReplicaDBInstanceIdentifiers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasReadReplicaDBInstanceIdentifiers() to see if a value was sent in this field.
    
    Returns:
    
    Contains one or more identifiers of the read replicas associated with this DB instance.
  - hasReadReplicaDBClusterIdentifiers
```
public final boolean hasReadReplicaDBClusterIdentifiers()
```
    Returns true if the ReadReplicaDBClusterIdentifiers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not 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.
    
    You can use hasReadReplicaDBClusterIdentifiers() to see if a value was sent in this field.
    
    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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not 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.
    
    Returns:
    
    License model information for this DB instance.
  - 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()
```
    Returns true if the OptionGroupMemberships property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasOptionGroupMemberships() to see if a value was sent in this field.
    
    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 instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance 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 instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance 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()
```
    Returns true if the StatusInfos property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasStatusInfos() to see if a value was sent in this field.
    
    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 DB instance.
    
    Returns:
    
    Specifies the storage type associated with 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 Amazon Web Services KMS customer master key (CMK).
    
    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 Amazon Web Services KMS customer master key (CMK).
  - 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 customer master key (CMK) 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 customer master key (CMK) for the DB instance is accessed.
  - caCertificateIdentifier
```
public final String caCertificateIdentifier()
```
    The identifier of the CA certificate for this DB instance.
    
    Returns:
    
    The identifier of the CA certificate for this DB instance.
  - hasDomainMemberships
```
public final boolean hasDomainMemberships()
```
    Returns true if the DomainMemberships property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasDomainMemberships() to see if a value was sent in this field.
    
    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.
    
    IAM database authentication can be enabled for the following database engines
    - For MySQL 5.6, minor version 5.6.34 or higher
    - For MySQL 5.7, minor version 5.7.16 or higher
    - Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
    Returns:
    True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
    
    IAM database authentication can be enabled for the following database engines
    
    For MySQL 5.6, minor version 5.6.34 or higher
    
    For MySQL 5.7, minor version 5.7.16 or higher
    
    Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
  - 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 Amazon Web Services KMS customer master key (CMK).
    
    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 Amazon Web Services KMS customer master key (CMK).
  - performanceInsightsRetentionPeriod
```
public final Integer performanceInsightsRetentionPeriod()
```
    The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
    
    Returns:
    
    The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
  - hasEnabledCloudwatchLogsExports
```
public final boolean hasEnabledCloudwatchLogsExports()
```
    Returns true if the EnabledCloudwatchLogsExports property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasEnabledCloudwatchLogsExports() to see if a value was sent in this field.
    
    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()
```
    Returns true if the ProcessorFeatures property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasProcessorFeatures() to see if a value was sent in this field.
    
    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()
```
    Returns true if the AssociatedRoles property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasAssociatedRoles() to see if a value was sent in this field.
    
    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 to which Amazon RDS can automatically scale the storage of the DB instance.
    
    Returns:
    
    The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
  - hasTagList
```
public final boolean hasTagList()
```
    Returns true if the TagList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasTagList() to see if a value was sent in this field.
    
    Returns:
    
    The value of the TagList property for this object.
  - hasDbInstanceAutomatedBackupsReplications
```
public final boolean hasDbInstanceAutomatedBackupsReplications()
```
    Returns true if the DBInstanceAutomatedBackupsReplications property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasDbInstanceAutomatedBackupsReplications() to see if a value was sent in this field.
    
    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 Amazon Web Services KMS customer master key (CMK).
    
    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 Amazon Web Services KMS customer master key (CMK).
  - 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.
  - 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

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

tagList