Package software.amazon.awssdk.services.docdbelastic.model

Class Cluster

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

Returns information about a specific elastic cluster.

See Also:

  • Method Details

    • adminUserName

      public final String adminUserName()

      The name of the elastic cluster administrator.

      Returns:
      The name of the elastic cluster administrator.

    • authType

      public final Auth authType()

      The authentication type for the elastic cluster.

      If the service returns an enum value that is not available in the current SDK version, authType will return Auth.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authTypeAsString().

      Returns:
      The authentication type for the elastic cluster.
      See Also:

    • authTypeAsString

      public final String authTypeAsString()

      The authentication type for the elastic cluster.

      If the service returns an enum value that is not available in the current SDK version, authType will return Auth.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authTypeAsString().

      Returns:
      The authentication type for the elastic cluster.
      See Also:

    • backupRetentionPeriod

      public final Integer backupRetentionPeriod()

      The number of days for which automatic snapshots are retained.

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

    • clusterArn

      public final String clusterArn()

      The ARN identifier of the elastic cluster.

      Returns:
      The ARN identifier of the elastic cluster.

    • clusterEndpoint

      public final String clusterEndpoint()

      The URL used to connect to the elastic cluster.

      Returns:
      The URL used to connect to the elastic cluster.

    • clusterName

      public final String clusterName()

      The name of the elastic cluster.

      Returns:
      The name of the elastic cluster.

    • createTime

      public final String createTime()

      The time when the elastic cluster was created in Universal Coordinated Time (UTC).

      Returns:
      The time when the elastic cluster was created in Universal Coordinated Time (UTC).

    • kmsKeyId

      public final String kmsKeyId()

      The KMS key identifier to use to encrypt the elastic cluster.

      Returns:
      The KMS key identifier to use to encrypt the elastic cluster.

    • preferredBackupWindow

      public final String preferredBackupWindow()

      The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod.

      Returns:
      The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod.

    • preferredMaintenanceWindow

      public final String preferredMaintenanceWindow()

      The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

      Format: ddd:hh24:mi-ddd:hh24:mi

      Returns:
      The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

      Format: ddd:hh24:mi-ddd:hh24:mi

    • shardCapacity

      public final Integer shardCapacity()

      The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

      Returns:
      The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

    • shardCount

      public final Integer shardCount()

      The number of shards assigned to the elastic cluster. Maximum is 32.

      Returns:
      The number of shards assigned to the elastic cluster. Maximum is 32.

    • shardInstanceCount

      public final Integer shardInstanceCount()

      The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

      Returns:
      The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

    • hasShards

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

    • shards

      public final List<Shard> shards()

      The total number of shards in the 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 hasShards() method.

      Returns:
      The total number of shards in the cluster.

    • status

      public final Status status()

      The status of the elastic cluster.

      If the service returns an enum value that is not available in the current SDK version, status will return Status.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the elastic cluster.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the elastic cluster.

      If the service returns an enum value that is not available in the current SDK version, status will return Status.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the elastic cluster.
      See Also:

    • hasSubnetIds

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

    • subnetIds

      public final List<String> subnetIds()

      The Amazon EC2 subnet IDs for the elastic 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 hasSubnetIds() method.

      Returns:
      The Amazon EC2 subnet IDs for the elastic cluster.

    • hasVpcSecurityGroupIds

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

    • vpcSecurityGroupIds

      public final List<String> vpcSecurityGroupIds()

      A list of EC2 VPC security groups associated with thie elastic 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 hasVpcSecurityGroupIds() method.

      Returns:
      A list of EC2 VPC security groups associated with thie elastic cluster.

    • toBuilder

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

    • builder

      public static Cluster.Builder builder()

    • serializableBuilderClass

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