DBInstance (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.neptune.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 Neptune 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
`Integer`	`allocatedStorage()` Specifies the allocated storage size specified in gibibytes.
`Boolean`	`autoMinorVersionUpgrade()` Indicates that minor version patches are applied automatically.
`String`	`availabilityZone()` Specifies the name of the Availability Zone the DB instance is located in.
`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.
`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.
`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 AWS Region-unique, immutable identifier for the DB instance.
`String`	`dbName()` The database name.
`List<DBParameterGroupStatus>`	`dbParameterGroups()` Provides the list of DB parameter groups applied to this DB instance.
`List<DBSecurityGroupMembership>`	`dbSecurityGroups()` Provides List of DB security group elements containing only `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.
`List<DomainMembership>`	`domainMemberships()` Not supported
`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()` Provides 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)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Boolean`	`iamDatabaseAuthenticationEnabled()` True if AWS Identity and Access Management (IAM) authentication 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 AWS 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.
`String`	`masterUsername()` Contains the master username for 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 Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
`Boolean`	`multiAZ()` Specifies if the DB instance is a Multi-AZ deployment.
`List<OptionGroupMembership>`	`optionGroupMemberships()` Provides the list of option group memberships for this DB instance.
`PendingModifiedValues`	`pendingModifiedValues()` 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 AWS KMS key identifier for encryption of 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).
`Integer`	`promotionTier()` A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.
`Boolean`	`publiclyAccessible()` This parameter is not supported.
`List<String>`	`readReplicaDBClusterIdentifiers()` Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.
`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.
`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.
`String`	`tdeCredentialArn()` The ARN from the key store with which the instance is associated for TDE encryption.
`String`	`timezone()` Not supported.
`DBInstance.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`List<VpcSecurityGroupMembership>`	`vpcSecurityGroups()` Provides a list of VPC security group elements that the DB instance belongs to.

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

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

- Method Detail
  - dbInstanceIdentifier
```
public 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 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 String engine()
```
    Provides the name of the database engine to be used for this DB instance.
    
    Returns:
    
    Provides the name of the database engine to be used for this DB instance.
  - dbInstanceStatus
```
public String dbInstanceStatus()
```
    Specifies the current state of this database.
    
    Returns:
    
    Specifies the current state of this database.
  - masterUsername
```
public String masterUsername()
```
    Contains the master username for the DB instance.
    
    Returns:
    
    Contains the master username for the DB instance.
  - dbName
```
public String dbName()
```
    The database name.
    
    Returns:
    
    The database name.
  - endpoint
```
public Endpoint endpoint()
```
    Specifies the connection endpoint.
    
    Returns:
    
    Specifies the connection endpoint.
  - allocatedStorage
```
public Integer allocatedStorage()
```
    Specifies the allocated storage size specified in gibibytes.
    
    Returns:
    
    Specifies the allocated storage size specified in gibibytes.
  - instanceCreateTime
```
public 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 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 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.
  - dbSecurityGroups
```
public List<DBSecurityGroupMembership> dbSecurityGroups()
```
    Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
  - vpcSecurityGroups
```
public 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.
    
    Returns:
    
    Provides a list of VPC security group elements that the DB instance belongs to.
  - dbParameterGroups
```
public 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.
    
    Returns:
    
    Provides the list of DB parameter groups applied to this DB instance.
  - availabilityZone
```
public 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 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 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 PendingModifiedValues pendingModifiedValues()
```
    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:
    
    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 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 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 String engineVersion()
```
    Indicates the database engine version.
    
    Returns:
    
    Indicates the database engine version.
  - autoMinorVersionUpgrade
```
public Boolean autoMinorVersionUpgrade()
```
    Indicates that minor version patches are applied automatically.
    
    Returns:
    
    Indicates that minor version patches are applied automatically.
  - readReplicaSourceDBInstanceIdentifier
```
public 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.
  - readReplicaDBInstanceIdentifiers
```
public 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.
    
    Returns:
    
    Contains one or more identifiers of the Read Replicas associated with this DB instance.
  - readReplicaDBClusterIdentifiers
```
public List<String> readReplicaDBClusterIdentifiers()
```
    Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.
  - licenseModel
```
public String licenseModel()
```
    License model information for this DB instance.
    
    Returns:
    
    License model information for this DB instance.
  - iops
```
public Integer iops()
```
    Specifies the Provisioned IOPS (I/O operations per second) value.
    
    Returns:
    
    Specifies the Provisioned IOPS (I/O operations per second) value.
  - optionGroupMemberships
```
public 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.
    
    Returns:
    
    Provides the list of option group memberships for this DB instance.
  - characterSetName
```
public 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.
  - secondaryAvailabilityZone
```
public 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 Boolean publiclyAccessible()
```
    This parameter is not supported.
    
    Returns:
    
    This parameter is not supported.
  - statusInfos
```
public List<DBInstanceStatusInfo> statusInfos()
```
    The status of a Read Replica. If the instance is not a Read Replica, this is blank.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The status of a Read Replica. If the instance is not a Read Replica, this is blank.
  - storageType
```
public String storageType()
```
    Specifies the storage type associated with DB instance.
    
    Returns:
    
    Specifies the storage type associated with DB instance.
  - tdeCredentialArn
```
public 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 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 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 Boolean storageEncrypted()
```
    Specifies whether the DB instance is encrypted.
    
    Returns:
    
    Specifies whether the DB instance is encrypted.
  - kmsKeyId
```
public String kmsKeyId()
```
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.
    
    Returns:
    
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.
  - dbiResourceId
```
public String dbiResourceId()
```
    The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.
    
    Returns:
    
    The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.
  - caCertificateIdentifier
```
public String caCertificateIdentifier()
```
    The identifier of the CA certificate for this DB instance.
    
    Returns:
    
    The identifier of the CA certificate for this DB instance.
  - domainMemberships
```
public List<DomainMembership> domainMemberships()
```
    Not supported
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Not supported
  - copyTagsToSnapshot
```
public Boolean copyTagsToSnapshot()
```
    Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
    
    Returns:
    
    Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
  - monitoringInterval
```
public 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 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 String monitoringRoleArn()
```
    The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
    
    Returns:
    
    The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
  - promotionTier
```
public Integer promotionTier()
```
    A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.
    
    Returns:
    
    A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.
  - dbInstanceArn
```
public String dbInstanceArn()
```
    The Amazon Resource Name (ARN) for the DB instance.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the DB instance.
  - timezone
```
public String timezone()
```
    Not supported.
    
    Returns:
    
    Not supported.
  - iamDatabaseAuthenticationEnabled
```
public Boolean iamDatabaseAuthenticationEnabled()
```
    True if AWS Identity and Access Management (IAM) authentication is enabled, and otherwise false.
    
    Returns:
    
    True if AWS Identity and Access Management (IAM) authentication is enabled, and otherwise false.
  - performanceInsightsEnabled
```
public 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 String performanceInsightsKMSKeyId()
```
    The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
    
    Returns:
    
    The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
  - enabledCloudwatchLogsExports
```
public List<String> enabledCloudwatchLogsExports()
```
    A list of log types that this DB instance is configured to export to CloudWatch Logs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of log types that this DB instance is configured to export to CloudWatch Logs.
  - toBuilder
```
public DBInstance.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DBInstance.Builder,DBInstance>
    
    Returns:
    
    a builder for type T
  - builder
```
public static DBInstance.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DBInstance.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

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

dbSecurityGroups

vpcSecurityGroups

dbParameterGroups

availabilityZone

dbSubnetGroup

preferredMaintenanceWindow

pendingModifiedValues

latestRestorableTime

multiAZ

engineVersion

autoMinorVersionUpgrade

readReplicaSourceDBInstanceIdentifier

readReplicaDBInstanceIdentifiers

readReplicaDBClusterIdentifiers

licenseModel

iops

optionGroupMemberships

characterSetName

secondaryAvailabilityZone

publiclyAccessible

statusInfos

storageType

tdeCredentialArn

dbInstancePort

dbClusterIdentifier

storageEncrypted

kmsKeyId

dbiResourceId

caCertificateIdentifier

domainMemberships

copyTagsToSnapshot

monitoringInterval

enhancedMonitoringResourceArn

monitoringRoleArn

promotionTier

dbInstanceArn

timezone

iamDatabaseAuthenticationEnabled

performanceInsightsEnabled

performanceInsightsKMSKeyId

enabledCloudwatchLogsExports

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields