java.lang.Object
software.amazon.awssdk.services.neptune.model.DBInstance
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DBInstance.Builder,DBInstance>

@Generated("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:
  • Method Details

    • 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()

      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 final String dbInstanceStatus()

      Specifies the current state of this database.

      Returns:
      Specifies the current state of this database.
    • masterUsername

      public final String masterUsername()

      Not supported by Neptune.

      Returns:
      Not supported by Neptune.
    • dbName

      public final String dbName()

      The database name.

      Returns:
      The database name.
    • endpoint

      public final Endpoint endpoint()

      Specifies the connection endpoint.

      Returns:
      Specifies the connection endpoint.
    • allocatedStorage

      public final Integer allocatedStorage()

      Not supported by Neptune.

      Returns:
      Not supported by Neptune.
    • 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()

      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.

      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:
      Provides List of DB security group elements containing only 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()

      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 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()

      Indicates that minor version patches are applied automatically.

      Returns:
      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 DB clusters that are Read Replicas of 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 hasReadReplicaDBClusterIdentifiers() method.

      Returns:
      Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.
    • 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()
      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()

      (Not supported by Neptune)

      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:
      (Not supported by Neptune)
    • characterSetName

      public final String characterSetName()

      (Not supported by Neptune)

      Returns:
      (Not supported by Neptune)
    • 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

      @Deprecated public final Boolean publiclyAccessible()
      Deprecated.

      This flag should no longer be used.

      Returns:
      This flag should no longer be used.
    • 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 is not 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 is not 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()

      Not supported: The encryption for DB instances is managed by the DB cluster.

      Returns:
      Not supported: The encryption for DB instances is managed by the DB cluster.
    • kmsKeyId

      public final String kmsKeyId()

      Not supported: The encryption for DB instances is managed by the DB cluster.

      Returns:
      Not supported: The encryption for DB instances is managed by the DB cluster.
    • dbiResourceId

      public final String dbiResourceId()

      The Amazon Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon CloudTrail log entries whenever the Amazon KMS key for the DB instance is accessed.

      Returns:
      The Amazon Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon CloudTrail log entries whenever the Amazon KMS key 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()
      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()

      Not supported

      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:
      Not supported
    • copyTagsToSnapshot

      public final 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 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 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 final 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 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()

      Not supported.

      Returns:
      Not supported.
    • iamDatabaseAuthenticationEnabled

      public final Boolean iamDatabaseAuthenticationEnabled()

      True if Amazon Identity and Access Management (IAM) authentication is enabled, and otherwise false.

      Returns:
      True if Amazon Identity and Access Management (IAM) authentication is enabled, and otherwise false.
    • performanceInsightsEnabled

      public final Boolean performanceInsightsEnabled()

      (Not supported by Neptune)

      Returns:
      (Not supported by Neptune)
    • performanceInsightsKMSKeyId

      public final String performanceInsightsKMSKeyId()

      (Not supported by Neptune)

      Returns:
      (Not supported by Neptune)
    • 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.

      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.
    • deletionProtection

      public final Boolean deletionProtection()

      Indicates whether or not the DB instance has deletion protection enabled. The instance can't be deleted when deletion protection is enabled. See Deleting a DB Instance.

      Returns:
      Indicates whether or not the DB instance has deletion protection enabled. The instance can't be deleted when deletion protection is enabled. See Deleting a DB Instance.
    • 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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.