Package software.amazon.awssdk.services.neptune.model

Class DBCluster

java.lang.Object
software.amazon.awssdk.services.neptune.model.DBCluster
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DBCluster.Builder,DBCluster>
@Generated("software.amazon.awssdk:codegen") public final class DBCluster extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DBCluster.Builder,DBCluster>

Contains the details of an Amazon Neptune DB cluster.

This data type is used as a response element in the DescribeDBClusters.

See Also:

  • Method Details

    • allocatedStorage

      public final Integer allocatedStorage()

      AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

      Returns:
      AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

    • hasAvailabilityZones

      public final boolean hasAvailabilityZones()
      For responses, this returns true if the service returned a value for the AvailabilityZones 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.

    • availabilityZones

      public final List<String> availabilityZones()

      Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

      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 hasAvailabilityZones() method.

      Returns:
      Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

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

    • characterSetName

      public final String characterSetName()

      Not supported by Neptune.

      Returns:
      Not supported by Neptune.

    • databaseName

      public final String databaseName()

      Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

      Returns:
      Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

    • dbClusterIdentifier

      public final String dbClusterIdentifier()

      Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

      Returns:
      Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

    • dbClusterParameterGroup

      public final String dbClusterParameterGroup()

      Specifies the name of the DB cluster parameter group for the DB cluster.

      Returns:
      Specifies the name of the DB cluster parameter group for the DB cluster.

    • dbSubnetGroup

      public final String dbSubnetGroup()

      Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

      Returns:
      Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

    • status

      public final String status()

      Specifies the current state of this DB cluster.

      Returns:
      Specifies the current state of this DB cluster.

    • percentProgress

      public final String percentProgress()

      Specifies the progress of the operation as a percentage.

      Returns:
      Specifies the progress of the operation as a percentage.

    • earliestRestorableTime

      public final Instant earliestRestorableTime()

      Specifies the earliest time to which a database can be restored with point-in-time restore.

      Returns:
      Specifies the earliest time to which a database can be restored with point-in-time restore.

    • endpoint

      public final String endpoint()

      Specifies the connection endpoint for the primary instance of the DB cluster.

      Returns:
      Specifies the connection endpoint for the primary instance of the DB cluster.

    • readerEndpoint

      public final String readerEndpoint()

      The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can help balance your read workload across multiple Read Replicas in your DB cluster.

      If a failover occurs, and the Read Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Read Replicas in the cluster, you can then reconnect to the reader endpoint.

      Returns:
      The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can help balance your read workload across multiple Read Replicas in your DB cluster.

      If a failover occurs, and the Read Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Read Replicas in the cluster, you can then reconnect to the reader endpoint.

    • multiAZ

      public final Boolean multiAZ()

      Specifies whether the DB cluster has instances in multiple Availability Zones.

      Returns:
      Specifies whether the DB cluster has instances in multiple Availability Zones.

    • engine

      public final String engine()

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

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

    • engineVersion

      public final String engineVersion()

      Indicates the database engine version.

      Returns:
      Indicates the database engine version.

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

    • port

      public final Integer port()

      Specifies the port that the database engine is listening on.

      Returns:
      Specifies the port that the database engine is listening on.

    • masterUsername

      public final String masterUsername()

      Not supported by Neptune.

      Returns:
      Not supported by Neptune.

    • hasDbClusterOptionGroupMemberships

      public final boolean hasDbClusterOptionGroupMemberships()
      For responses, this returns true if the service returned a value for the DBClusterOptionGroupMemberships 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.

    • dbClusterOptionGroupMemberships

      public final List<DBClusterOptionGroupStatus> dbClusterOptionGroupMemberships()

      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 hasDbClusterOptionGroupMemberships() method.

      Returns:
      Not supported by Neptune.

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

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

    • replicationSourceIdentifier

      public final String replicationSourceIdentifier()

      Not supported by Neptune.

      Returns:
      Not supported by Neptune.

    • hasReadReplicaIdentifiers

      public final boolean hasReadReplicaIdentifiers()
      For responses, this returns true if the service returned a value for the ReadReplicaIdentifiers 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.

    • readReplicaIdentifiers

      public final List<String> readReplicaIdentifiers()

      Contains one or more identifiers of the Read Replicas associated with this DB cluster.

      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 hasReadReplicaIdentifiers() method.

      Returns:
      Contains one or more identifiers of the Read Replicas associated with this DB cluster.

    • hasDbClusterMembers

      public final boolean hasDbClusterMembers()
      For responses, this returns true if the service returned a value for the DBClusterMembers 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.

    • dbClusterMembers

      public final List<DBClusterMember> dbClusterMembers()

      Provides the list of instances that make up the DB cluster.

      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 hasDbClusterMembers() method.

      Returns:
      Provides the list of instances that make up the DB cluster.

    • 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 groups that the DB cluster 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 groups that the DB cluster belongs to.

    • hostedZoneId

      public final String hostedZoneId()

      Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

      Returns:
      Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

    • storageEncrypted

      public final Boolean storageEncrypted()

      Specifies whether the DB cluster is encrypted.

      Returns:
      Specifies whether the DB cluster is encrypted.

    • kmsKeyId

      public final String kmsKeyId()

      If StorageEncrypted is true, the Amazon KMS key identifier for the encrypted DB cluster.

      Returns:
      If StorageEncrypted is true, the Amazon KMS key identifier for the encrypted DB cluster.

    • dbClusterResourceId

      public final String dbClusterResourceId()

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

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

    • dbClusterArn

      public final String dbClusterArn()

      The Amazon Resource Name (ARN) for the DB cluster.

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

    • hasAssociatedRoles

      public final boolean hasAssociatedRoles()
      For responses, this returns true if the service returned a value for the AssociatedRoles property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • associatedRoles

      public final List<DBClusterRole> associatedRoles()

      Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAssociatedRoles() method.

      Returns:
      Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf.

    • iamDatabaseAuthenticationEnabled

      public final Boolean iamDatabaseAuthenticationEnabled()

      True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

      Returns:
      True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    • cloneGroupId

      public final String cloneGroupId()

      Identifies the clone group to which the DB cluster is associated.

      Returns:
      Identifies the clone group to which the DB cluster is associated.

    • clusterCreateTime

      public final Instant clusterCreateTime()

      Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

      Returns:
      Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

    • copyTagsToSnapshot

      public final Boolean copyTagsToSnapshot()

      If set to true, tags are copied to any snapshot of the DB cluster that is created.

      Returns:
      If set to true, tags are copied to any snapshot of the DB cluster that is created.

    • 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 the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: audit (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See Publishing Neptune logs to Amazon 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 the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: audit (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See Publishing Neptune logs to Amazon CloudWatch logs.

    • pendingModifiedValues

      public final ClusterPendingModifiedValues pendingModifiedValues()

      This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

      Returns:
      This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

    • deletionProtection

      public final Boolean deletionProtection()

      Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

      Returns:
      Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

    • crossAccountClone

      public final Boolean crossAccountClone()

      If set to true, the DB cluster can be cloned across accounts.

      Returns:
      If set to true, the DB cluster can be cloned across accounts.

    • automaticRestartTime

      public final Instant automaticRestartTime()

      Time at which the DB cluster will be automatically restarted.

      Returns:
      Time at which the DB cluster will be automatically restarted.

    • serverlessV2ScalingConfiguration

      public final ServerlessV2ScalingConfigurationInfo serverlessV2ScalingConfiguration()

      Shows the scaling configuration for a Neptune Serverless DB cluster.

      For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

      Returns:
      Shows the scaling configuration for a Neptune Serverless DB cluster.

      For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

    • globalClusterIdentifier

      public final String globalClusterIdentifier()

      Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.

      Returns:
      Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.

    • ioOptimizedNextAllowedModificationTime

      public final Instant ioOptimizedNextAllowedModificationTime()

      The next time you can modify the DB cluster to use the iopt1 storage type.

      Returns:
      The next time you can modify the DB cluster to use the iopt1 storage type.

    • storageType

      public final String storageType()

      The storage type associated with the DB cluster.

      Returns:
      The storage type associated with the DB cluster.

    • toBuilder

      public DBCluster.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<DBCluster.Builder,DBCluster>
      Returns:
      a builder for type T

    • builder

      public static DBCluster.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DBCluster.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.