Class DBShardGroup

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

Contains the details for an Amazon RDS DB shard group.

See Also:

  • Method Details

    • dbShardGroupResourceId

      public final String dbShardGroupResourceId()

      The Amazon Web Services Region-unique, immutable identifier for the DB shard group.

      Returns:
      The Amazon Web Services Region-unique, immutable identifier for the DB shard group.

    • dbShardGroupIdentifier

      public final String dbShardGroupIdentifier()

      The name of the DB shard group.

      Returns:
      The name of the DB shard group.

    • dbClusterIdentifier

      public final String dbClusterIdentifier()

      The name of the primary DB cluster for the DB shard group.

      Returns:
      The name of the primary DB cluster for the DB shard group.

    • maxACU

      public final Double maxACU()

      The maximum capacity of the DB shard group in Aurora capacity units (ACUs).

      Returns:
      The maximum capacity of the DB shard group in Aurora capacity units (ACUs).

    • minACU

      public final Double minACU()

      The minimum capacity of the DB shard group in Aurora capacity units (ACUs).

      Returns:
      The minimum capacity of the DB shard group in Aurora capacity units (ACUs).

    • computeRedundancy

      public final Integer computeRedundancy()

      Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:

      • 0 - Creates a DB shard group without a standby DB shard group. This is the default value.

      • 1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).

      • 2 - Creates a DB shard group with two standby DB shard groups in two different AZs.

      Returns:
      Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:

      • 0 - Creates a DB shard group without a standby DB shard group. This is the default value.

      • 1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).

      • 2 - Creates a DB shard group with two standby DB shard groups in two different AZs.

    • status

      public final String status()

      The status of the DB shard group.

      Returns:
      The status of the DB shard group.

    • publiclyAccessible

      public final Boolean publiclyAccessible()

      Indicates whether the DB shard group is publicly accessible.

      When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB shard group doesn't permit it.

      When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.

      For more information, see CreateDBShardGroup.

      This setting is only for Aurora Limitless Database.

      Returns:
      Indicates whether the DB shard group is publicly accessible.

      When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB shard group doesn't permit it.

      When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.

      For more information, see CreateDBShardGroup.

      This setting is only for Aurora Limitless Database.

    • endpoint

      public final String endpoint()

      The connection endpoint for the DB shard group.

      Returns:
      The connection endpoint for the DB shard group.

    • dbShardGroupArn

      public final String dbShardGroupArn()

      The Amazon Resource Name (ARN) for the DB shard group.

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

    • hasTagList

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

    • tagList

      public final List<Tag> tagList()
      Returns the value of the TagList property for this object.

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

      Returns:
      The value of the TagList property for this object.

    • toBuilder

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

    • builder

      public static DBShardGroup.Builder builder()

    • serializableBuilderClass

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