Class DBInstance

java.lang.Object
software.amazon.awssdk.services.docdb.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>

Detailed information about an instance.

See Also:

  • Method Details

    • dbInstanceIdentifier

      public final String dbInstanceIdentifier()

      Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

      Returns:
      Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

    • dbInstanceClass

      public final String dbInstanceClass()

      Contains the name of the compute and memory capacity class of the instance.

      Returns:
      Contains the name of the compute and memory capacity class of the instance.

    • engine

      public final String engine()

      Provides the name of the database engine to be used for this instance.

      Returns:
      Provides the name of the database engine to be used for this instance.

    • dbInstanceStatus

      public final String dbInstanceStatus()

      Specifies the current state of this database.

      Returns:
      Specifies the current state of this database.

    • endpoint

      public final Endpoint endpoint()

      Specifies the connection endpoint.

      Returns:
      Specifies the connection endpoint.

    • instanceCreateTime

      public final Instant instanceCreateTime()

      Provides the date and time that the instance was created.

      Returns:
      Provides the date and time that the 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 snapshots are retained.

      Returns:
      Specifies the number of days for which automatic snapshots are retained.

    • 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 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 instance belongs to.

    • availabilityZone

      public final String availabilityZone()

      Specifies the name of the Availability Zone that the instance is located in.

      Returns:
      Specifies the name of the Availability Zone that the instance is located in.

    • dbSubnetGroup

      public final DBSubnetGroup dbSubnetGroup()

      Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

      Returns:
      Specifies information on the subnet group that is associated with the 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 instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

      Returns:
      Specifies that changes to the instance are pending. This element is included only 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.

    • engineVersion

      public final String engineVersion()

      Indicates the database engine version.

      Returns:
      Indicates the database engine version.

    • autoMinorVersionUpgrade

      public final Boolean autoMinorVersionUpgrade()

      Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

      Returns:
      Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

    • publiclyAccessible

      public final Boolean publiclyAccessible()

      Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

      Returns:
      Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

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

    • dbClusterIdentifier

      public final String dbClusterIdentifier()

      Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

      Returns:
      Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

    • storageEncrypted

      public final Boolean storageEncrypted()

      Specifies whether or not the instance is encrypted.

      Returns:
      Specifies whether or not the instance is encrypted.

    • kmsKeyId

      public final String kmsKeyId()

      If StorageEncrypted is true, the KMS key identifier for the encrypted instance.

      Returns:
      If StorageEncrypted is true, the KMS key identifier for the encrypted instance.

    • dbiResourceId

      public final String dbiResourceId()

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

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

    • copyTagsToSnapshot

      public final Boolean copyTagsToSnapshot()

      A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

      Returns:
      A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

    • promotionTier

      public final Integer promotionTier()

      A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

      Returns:
      A value that specifies the order in which an Amazon DocumentDB 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 instance.

      Returns:
      The Amazon Resource Name (ARN) for the instance.

    • 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 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 instance is configured to export to CloudWatch Logs.

    • certificateDetails

      public final CertificateDetails certificateDetails()

      The details of the DB instance's server certificate.

      Returns:
      The details of the DB instance's server certificate.

    • performanceInsightsEnabled

      public final Boolean performanceInsightsEnabled()

      Set to true if Amazon RDS Performance Insights is enabled for the DB instance, and otherwise false.

      Returns:
      Set to true if Amazon RDS Performance Insights is enabled for the DB instance, and otherwise false.

    • performanceInsightsKMSKeyId

      public final String performanceInsightsKMSKeyId()

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.