Class DBSubnetGroup

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

Contains the details of an Amazon RDS DB subnet group.

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

See Also:

  • Method Details

    • dbSubnetGroupName

      public final String dbSubnetGroupName()

      The name of the DB subnet group.

      Returns:
      The name of the DB subnet group.

    • dbSubnetGroupDescription

      public final String dbSubnetGroupDescription()

      Provides the description of the DB subnet group.

      Returns:
      Provides the description of the DB subnet group.

    • vpcId

      public final String vpcId()

      Provides the VpcId of the DB subnet group.

      Returns:
      Provides the VpcId of the DB subnet group.

    • subnetGroupStatus

      public final String subnetGroupStatus()

      Provides the status of the DB subnet group.

      Returns:
      Provides the status of the DB subnet group.

    • hasSubnets

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

    • subnets

      public final List<Subnet> subnets()

      Contains a list of Subnet elements. The list of subnets shown here might not reflect the current state of your VPC. For the most up-to-date information, we recommend checking your VPC configuration directly.

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

      Returns:
      Contains a list of Subnet elements. The list of subnets shown here might not reflect the current state of your VPC. For the most up-to-date information, we recommend checking your VPC configuration directly.

    • dbSubnetGroupArn

      public final String dbSubnetGroupArn()

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

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

    • hasSupportedNetworkTypes

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

    • supportedNetworkTypes

      public final List<String> supportedNetworkTypes()

      The network type of the DB subnet group.

      Valid values:

      • IPV4

      • DUAL

      A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).

      For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

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

      Returns:
      The network type of the DB subnet group.

      Valid values:

      • IPV4

      • DUAL

      A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).

      For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

    • toBuilder

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

    • builder

      public static DBSubnetGroup.Builder builder()

    • serializableBuilderClass

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