DBSubnetGroup (AWS Java SDK :: Services :: Amazon RDS 2.20.99 API)

java.lang.Object
- software.amazon.awssdk.services.rds.model.DBSubnetGroup

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DBSubnetGroup.Builder,DBSubnetGroup>
```
@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DBSubnetGroup.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DBSubnetGroup.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DBSubnetGroup.Builder`	`builder()`
`String`	`dbSubnetGroupArn()` The Amazon Resource Name (ARN) for the DB subnet group.
`String`	`dbSubnetGroupDescription()` Provides the description of the DB subnet group.
`String`	`dbSubnetGroupName()` The name of the DB subnet group.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSubnets()` For responses, this returns true if the service returned a value for the Subnets property.
`boolean`	`hasSupportedNetworkTypes()` For responses, this returns true if the service returned a value for the SupportedNetworkTypes property.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DBSubnetGroup.Builder>`	`serializableBuilderClass()`
`String`	`subnetGroupStatus()` Provides the status of the DB subnet group.
`List<Subnet>`	`subnets()` Contains a list of `Subnet` elements.
`List<String>`	`supportedNetworkTypes()` The network type of the DB subnet group.
`DBSubnetGroup.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`vpcId()` Provides the VpcId of the DB subnet group.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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.
    
    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.
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DBSubnetGroup.Builder,DBSubnetGroup>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class DBSubnetGroup

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

dbSubnetGroupName

dbSubnetGroupDescription

vpcId

subnetGroupStatus

hasSubnets

subnets

dbSubnetGroupArn

hasSupportedNetworkTypes

supportedNetworkTypes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields