Class Subnet
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.Subnet
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Subnet.Builder,Subnet>
@Generated("software.amazon.awssdk:codegen") public final class Subnet extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Subnet.Builder,Subnet>
Describes a subnet.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Subnet.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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.String
availabilityZoneId()
The AZ ID 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.String
customerOwnedIpv4Pool()
The customer-owned IPv4 address pool associated with the subnet.Boolean
defaultForAz()
Indicates whether this is the default subnet for the Availability Zone.Boolean
enableDns64()
Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.Integer
enableLniAtDeviceIndex()
Indicates the device position for local network interfaces in this subnet.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasIpv6CidrBlockAssociationSet()
For responses, this returns true if the service returned a value for the Ipv6CidrBlockAssociationSet property.boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.List<SubnetIpv6CidrBlockAssociation>
ipv6CidrBlockAssociationSet()
Information about the IPv6 CIDR blocks associated with the subnet.Boolean
ipv6Native()
Indicates whether this is an IPv6 only subnet.Boolean
mapCustomerOwnedIpOnLaunch()
Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.Boolean
mapPublicIpOnLaunch()
Indicates whether instances launched in this subnet receive a public IPv4 address.String
outpostArn()
The Amazon Resource Name (ARN) of the Outpost.String
ownerId()
The ID of the Amazon Web Services account that owns the subnet.PrivateDnsNameOptionsOnLaunch
privateDnsNameOptionsOnLaunch()
The type of hostnames to assign to instances in the subnet at launch.List<SdkField<?>>
sdkFields()
static Class<? extends Subnet.Builder>
serializableBuilderClass()
SubnetState
state()
The current state of the subnet.String
stateAsString()
The current state of the subnet.String
subnetArn()
The Amazon Resource Name (ARN) of the subnet.String
subnetId()
The ID of the subnet.List<Tag>
tags()
Any tags assigned to the subnet.Subnet.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
vpcId()
The ID of the VPC the subnet is in.-
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
-
availabilityZone
public final String availabilityZone()
The Availability Zone of the subnet.
- Returns:
- The Availability Zone of the subnet.
-
availabilityZoneId
public final String availabilityZoneId()
The AZ ID of the subnet.
- Returns:
- The AZ ID of the subnet.
-
availableIpAddressCount
public final Integer availableIpAddressCount()
The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.
- Returns:
- The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.
-
cidrBlock
public final String cidrBlock()
The IPv4 CIDR block assigned to the subnet.
- Returns:
- The IPv4 CIDR block assigned to the subnet.
-
defaultForAz
public final 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.
-
enableLniAtDeviceIndex
public final Integer enableLniAtDeviceIndex()
Indicates the device position for local network interfaces in this subnet. For example,
1
indicates local network interfaces in this subnet are the secondary network interface (eth1).- Returns:
- Indicates the device position for local network interfaces in this subnet. For example,
1
indicates local network interfaces in this subnet are the secondary network interface (eth1).
-
mapPublicIpOnLaunch
public final 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.
-
mapCustomerOwnedIpOnLaunch
public final Boolean mapCustomerOwnedIpOnLaunch()
Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.
- Returns:
- Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.
-
customerOwnedIpv4Pool
public final String customerOwnedIpv4Pool()
The customer-owned IPv4 address pool associated with the subnet.
- Returns:
- The customer-owned IPv4 address pool associated with the subnet.
-
state
public final 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 returnSubnetState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the subnet.
- See Also:
SubnetState
-
stateAsString
public final 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 returnSubnetState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the subnet.
- See Also:
SubnetState
-
subnetId
public final String subnetId()
The ID of the subnet.
- Returns:
- The ID of the subnet.
-
vpcId
public final String vpcId()
The ID of the VPC the subnet is in.
- Returns:
- The ID of the VPC the subnet is in.
-
ownerId
public final String ownerId()
The ID of the Amazon Web Services account that owns the subnet.
- Returns:
- The ID of the Amazon Web Services account that owns the subnet.
-
assignIpv6AddressOnCreation
public final 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.
-
hasIpv6CidrBlockAssociationSet
public final boolean hasIpv6CidrBlockAssociationSet()
For responses, this returns true if the service returned a value for the Ipv6CidrBlockAssociationSet 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.
-
ipv6CidrBlockAssociationSet
public final 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.
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
hasIpv6CidrBlockAssociationSet()
method.- Returns:
- Information about the IPv6 CIDR blocks associated with the subnet.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags 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.
-
tags
public final List<Tag> tags()
Any tags assigned to the subnet.
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
hasTags()
method.- Returns:
- Any tags assigned to the subnet.
-
subnetArn
public final String subnetArn()
The Amazon Resource Name (ARN) of the subnet.
- Returns:
- The Amazon Resource Name (ARN) of the subnet.
-
outpostArn
public final String outpostArn()
The Amazon Resource Name (ARN) of the Outpost.
- Returns:
- The Amazon Resource Name (ARN) of the Outpost.
-
enableDns64
public final Boolean enableDns64()
Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
- Returns:
- Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
-
ipv6Native
public final Boolean ipv6Native()
Indicates whether this is an IPv6 only subnet.
- Returns:
- Indicates whether this is an IPv6 only subnet.
-
privateDnsNameOptionsOnLaunch
public final PrivateDnsNameOptionsOnLaunch privateDnsNameOptionsOnLaunch()
The type of hostnames to assign to instances in the subnet at launch. An instance hostname is based on the IPv4 address or ID of the instance.
- Returns:
- The type of hostnames to assign to instances in the subnet at launch. An instance hostname is based on the IPv4 address or ID of the instance.
-
toBuilder
public Subnet.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<Subnet.Builder,Subnet>
-
builder
public static Subnet.Builder builder()
-
serializableBuilderClass
public static Class<? extends Subnet.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-