Class DBSubnetGroup
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DBSubnetGroup.Builder
builder()
final String
The Amazon Resource Name (ARN) for the DB subnet group.final String
Provides the description of the DB subnet group.final String
The name of the DB subnet group.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Subnets property.final boolean
For responses, this returns true if the service returned a value for the SupportedNetworkTypes property.static Class
<? extends DBSubnetGroup.Builder> final String
Provides the status of the DB subnet group.subnets()
Contains a list ofSubnet
elements.The network type of the DB subnet group.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
vpcId()
Provides the VpcId of the DB subnet group.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
dbSubnetGroupName
The name of the DB subnet group.
- Returns:
- The name of the DB subnet group.
-
dbSubnetGroupDescription
Provides the description of the DB subnet group.
- Returns:
- Provides the description of the DB subnet group.
-
vpcId
Provides the VpcId of the DB subnet group.
- Returns:
- Provides the VpcId of the DB subnet group.
-
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 theisEmpty()
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
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
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<DBSubnetGroup.Builder,
DBSubnetGroup> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-