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:

  • Method Details

    • availabilityZoneId

      public final String availabilityZoneId()

      The AZ ID of the subnet.

      Returns:
      The AZ ID of the subnet.

    • 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).

    • 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.

    • 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 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.

    • 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 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.

    • 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.

    • subnetId

      public final String subnetId()

      The ID of the subnet.

      Returns:
      The ID of 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 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:

    • 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 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:

    • vpcId

      public final String vpcId()

      The ID of the VPC the subnet is in.

      Returns:
      The ID of the VPC the subnet is in.

    • cidrBlock

      public final String cidrBlock()

      The IPv4 CIDR block assigned to the subnet.

      Returns:
      The IPv4 CIDR block assigned to 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.

    • availabilityZone

      public final String availabilityZone()

      The Availability Zone of the subnet.

      Returns:
      The Availability Zone of 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.

    • mapPublicIpOnLaunch

      public final Boolean mapPublicIpOnLaunch()

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

      Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.

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

      Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.

    • 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 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.