Package software.amazon.awssdk.services.elasticache.model

Class CacheSubnetGroup

java.lang.Object

software.amazon.awssdk.services.elasticache.model.CacheSubnetGroup

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CacheSubnetGroup.Builder,CacheSubnetGroup>

@Generated("software.amazon.awssdk:codegen")
public final class CacheSubnetGroup
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CacheSubnetGroup.Builder,CacheSubnetGroup>

Represents the output of one of the following operations:

• CreateCacheSubnetGroup

• ModifyCacheSubnetGroup

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CacheSubnetGroup.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The ARN (Amazon Resource Name) of the cache subnet group.
static CacheSubnetGroup.Builder	builder()
String	cacheSubnetGroupDescription()	The description of the cache subnet group.
String	cacheSubnetGroupName()	The name of the cache 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 CacheSubnetGroup.Builder>	serializableBuilderClass()
List<Subnet>	subnets()	A list of subnets associated with the cache subnet group.
List<NetworkType>	supportedNetworkTypes()	Either ipv4 | ipv6 | dual_stack.
List<String>	supportedNetworkTypesAsStrings()	Either ipv4 | ipv6 | dual_stack.
CacheSubnetGroup.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	vpcId()	The Amazon Virtual Private Cloud identifier (VPC ID) of the cache 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

cacheSubnetGroupName

public final String cacheSubnetGroupName()

The name of the cache subnet group.

Returns:

The name of the cache subnet group.

cacheSubnetGroupDescription

public final String cacheSubnetGroupDescription()

The description of the cache subnet group.

Returns:

The description of the cache subnet group.

vpcId

public final String vpcId()

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.

Returns:

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache 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()

A list of subnets associated with the cache subnet group.

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:

A list of subnets associated with the cache subnet group.

arn

public final String arn()

The ARN (Amazon Resource Name) of the cache subnet group.

Returns:

The ARN (Amazon Resource Name) of the cache subnet group.

supportedNetworkTypes

public final List<NetworkType> supportedNetworkTypes()

Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

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:

Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

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.

supportedNetworkTypesAsStrings

public final List<String> supportedNetworkTypesAsStrings()

Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

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:

Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

toBuilder

public CacheSubnetGroup.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CacheSubnetGroup.Builder,CacheSubnetGroup>

builder

public static CacheSubnetGroup.Builder builder()

serializableBuilderClass

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