software.amazon.awssdk.services.ec2.model

Class Subnet

java.lang.Object

software.amazon.awssdk.services.ec2.model.Subnet

All Implemented Interfaces:

ToCopyableBuilder<Subnet.Builder,Subnet>

@Generated(value="software.amazon.awssdk:codegen")
public final class Subnet
extends Object
implements ToCopyableBuilder<Subnet.Builder,Subnet>

Describes a subnet.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Subnet.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	assignIpv6AddressOnCreation() Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address.
String	availabilityZone() The Availability Zone of the subnet.
Integer	availableIpAddressCount() The number of unused private IPv4 addresses in the subnet.
static Subnet.Builder	builder()
String	cidrBlock() The IPv4 CIDR block assigned to the subnet.
Boolean	defaultForAz() Indicates whether this is the default subnet for the Availability Zone.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SubnetIpv6CidrBlockAssociation>	ipv6CidrBlockAssociationSet() Information about the IPv6 CIDR blocks associated with the subnet.
Boolean	mapPublicIpOnLaunch() Indicates whether instances launched in this subnet receive a public IPv4 address.
static Class<? extends Subnet.Builder>	serializableBuilderClass()
SubnetState	state() The current state of the subnet.
String	stateAsString() The current state of the subnet.
String	subnetId() The ID of the subnet.
List<Tag>	tags() Any tags assigned to the subnet.
Subnet.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	vpcId() The ID of the VPC the subnet is in.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

availabilityZone

public String availabilityZone()

The Availability Zone of the subnet.

Returns:

The Availability Zone of the subnet.

availableIpAddressCount

public Integer availableIpAddressCount()

The number of unused private IPv4 addresses in the subnet. Note that the IPv4 addresses for any stopped instances are considered unavailable.

Returns:

The number of unused private IPv4 addresses in the subnet. Note that the IPv4 addresses for any stopped instances are considered unavailable.

cidrBlock

public String cidrBlock()

The IPv4 CIDR block assigned to the subnet.

Returns:

The IPv4 CIDR block assigned to the subnet.

defaultForAz

public Boolean defaultForAz()

Indicates whether this is the default subnet for the Availability Zone.

Returns:

Indicates whether this is the default subnet for the Availability Zone.

mapPublicIpOnLaunch

public Boolean mapPublicIpOnLaunch()

Indicates whether instances launched in this subnet receive a public IPv4 address.

Returns:

Indicates whether instances launched in this subnet receive a public IPv4 address.

state

public SubnetState state()

The current state of the subnet.

If the service returns an enum value that is not available in the current SDK version, state will return SubnetState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The current state of the subnet.

See Also:

SubnetState

stateAsString

public String stateAsString()

The current state of the subnet.

If the service returns an enum value that is not available in the current SDK version, state will return SubnetState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The current state of the subnet.

See Also:

SubnetState

subnetId

public String subnetId()

The ID of the subnet.

Returns:

The ID of the subnet.

vpcId

public String vpcId()

The ID of the VPC the subnet is in.

Returns:

The ID of the VPC the subnet is in.

assignIpv6AddressOnCreation

public Boolean assignIpv6AddressOnCreation()

Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address.

Returns:

Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address.

ipv6CidrBlockAssociationSet

public List<SubnetIpv6CidrBlockAssociation> ipv6CidrBlockAssociationSet()

Information about the IPv6 CIDR blocks associated with the subnet.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Information about the IPv6 CIDR blocks associated with the subnet.

tags

public List<Tag> tags()

Any tags assigned to the subnet.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Any tags assigned to the subnet.

toBuilder

public Subnet.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<Subnet.Builder,Subnet>

Returns:

a builder for type T

builder

public static Subnet.Builder builder()

serializableBuilderClass

public static Class<? extends Subnet.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)