Class NetworkInterface

java.lang.Object
software.amazon.awssdk.services.ec2.model.NetworkInterface
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<NetworkInterface.Builder,NetworkInterface>
@Generated("software.amazon.awssdk:codegen") public final class NetworkInterface extends Object implements SdkPojo, Serializable, ToCopyableBuilder<NetworkInterface.Builder,NetworkInterface>

Describes a network interface.

See Also:

  • Method Details

    • association

      public final NetworkInterfaceAssociation association()

      The association information for an Elastic IP address (IPv4) associated with the network interface.

      Returns:
      The association information for an Elastic IP address (IPv4) associated with the network interface.

    • attachment

      public final NetworkInterfaceAttachment attachment()

      The network interface attachment.

      Returns:
      The network interface attachment.

    • availabilityZone

      public final String availabilityZone()

      The Availability Zone.

      Returns:
      The Availability Zone.

    • connectionTrackingConfiguration

      public final ConnectionTrackingConfiguration connectionTrackingConfiguration()

      A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.

      Returns:
      A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.

    • description

      public final String description()

      A description.

      Returns:
      A description.

    • hasGroups

      public final boolean hasGroups()
      For responses, this returns true if the service returned a value for the Groups 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.

    • groups

      public final List<GroupIdentifier> groups()

      Any security groups for the network interface.

      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 hasGroups() method.

      Returns:
      Any security groups for the network interface.

    • interfaceType

      public final NetworkInterfaceType interfaceType()

      The type of network interface.

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

      Returns:
      The type of network interface.
      See Also:

    • interfaceTypeAsString

      public final String interfaceTypeAsString()

      The type of network interface.

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

      Returns:
      The type of network interface.
      See Also:

    • hasIpv6Addresses

      public final boolean hasIpv6Addresses()
      For responses, this returns true if the service returned a value for the Ipv6Addresses 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.

    • ipv6Addresses

      public final List<NetworkInterfaceIpv6Address> ipv6Addresses()

      The IPv6 addresses associated with the network interface.

      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 hasIpv6Addresses() method.

      Returns:
      The IPv6 addresses associated with the network interface.

    • macAddress

      public final String macAddress()

      The MAC address.

      Returns:
      The MAC address.

    • networkInterfaceId

      public final String networkInterfaceId()

      The ID of the network interface.

      Returns:
      The ID of the network interface.

    • outpostArn

      public final String outpostArn()

      The Amazon Resource Name (ARN) of the Outpost.

      Returns:
      The Amazon Resource Name (ARN) of the Outpost.

    • ownerId

      public final String ownerId()

      The Amazon Web Services account ID of the owner of the network interface.

      Returns:
      The Amazon Web Services account ID of the owner of the network interface.

    • privateDnsName

      public final String privateDnsName()

      The private DNS name.

      Returns:
      The private DNS name.

    • privateIpAddress

      public final String privateIpAddress()

      The IPv4 address of the network interface within the subnet.

      Returns:
      The IPv4 address of the network interface within the subnet.

    • hasPrivateIpAddresses

      public final boolean hasPrivateIpAddresses()
      For responses, this returns true if the service returned a value for the PrivateIpAddresses 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.

    • privateIpAddresses

      public final List<NetworkInterfacePrivateIpAddress> privateIpAddresses()

      The private IPv4 addresses associated with the network interface.

      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 hasPrivateIpAddresses() method.

      Returns:
      The private IPv4 addresses associated with the network interface.

    • hasIpv4Prefixes

      public final boolean hasIpv4Prefixes()
      For responses, this returns true if the service returned a value for the Ipv4Prefixes 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.

    • ipv4Prefixes

      public final List<Ipv4PrefixSpecification> ipv4Prefixes()

      The IPv4 prefixes that are assigned to the network interface.

      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 hasIpv4Prefixes() method.

      Returns:
      The IPv4 prefixes that are assigned to the network interface.

    • hasIpv6Prefixes

      public final boolean hasIpv6Prefixes()
      For responses, this returns true if the service returned a value for the Ipv6Prefixes 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.

    • ipv6Prefixes

      public final List<Ipv6PrefixSpecification> ipv6Prefixes()

      The IPv6 prefixes that are assigned to the network interface.

      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 hasIpv6Prefixes() method.

      Returns:
      The IPv6 prefixes that are assigned to the network interface.

    • requesterId

      public final String requesterId()

      The alias or Amazon Web Services account ID of the principal or service that created the network interface.

      Returns:
      The alias or Amazon Web Services account ID of the principal or service that created the network interface.

    • requesterManaged

      public final Boolean requesterManaged()

      Indicates whether the network interface is being managed by Amazon Web Services.

      Returns:
      Indicates whether the network interface is being managed by Amazon Web Services.

    • sourceDestCheck

      public final Boolean sourceDestCheck()

      Indicates whether source/destination checking is enabled.

      Returns:
      Indicates whether source/destination checking is enabled.

    • status

      public final NetworkInterfaceStatus status()

      The status of the network interface.

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

      Returns:
      The status of the network interface.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the network interface.

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

      Returns:
      The status of the network interface.
      See Also:

    • subnetId

      public final String subnetId()

      The ID of the subnet.

      Returns:
      The ID of the subnet.

    • hasTagSet

      public final boolean hasTagSet()
      For responses, this returns true if the service returned a value for the TagSet 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.

    • tagSet

      public final List<Tag> tagSet()

      Any tags assigned to the network interface.

      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 hasTagSet() method.

      Returns:
      Any tags assigned to the network interface.

    • vpcId

      public final String vpcId()

      The ID of the VPC.

      Returns:
      The ID of the VPC.

    • denyAllIgwTraffic

      public final Boolean denyAllIgwTraffic()

      Indicates whether a network interface with an IPv6 address is unreachable from the public internet. If the value is true, inbound traffic from the internet is dropped and you cannot assign an elastic IP address to the network interface. The network interface is reachable from peered VPCs and resources connected through a transit gateway, including on-premises networks.

      Returns:
      Indicates whether a network interface with an IPv6 address is unreachable from the public internet. If the value is true, inbound traffic from the internet is dropped and you cannot assign an elastic IP address to the network interface. The network interface is reachable from peered VPCs and resources connected through a transit gateway, including on-premises networks.

    • ipv6Native

      public final Boolean ipv6Native()

      Indicates whether this is an IPv6 only network interface.

      Returns:
      Indicates whether this is an IPv6 only network interface.

    • ipv6Address

      public final String ipv6Address()

      The IPv6 globally unique address associated with the network interface.

      Returns:
      The IPv6 globally unique address associated with the network interface.

    • toBuilder

      public NetworkInterface.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<NetworkInterface.Builder,NetworkInterface>
      Returns:
      a builder for type T

    • builder

      public static NetworkInterface.Builder builder()

    • serializableBuilderClass

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