Class LoadBalancer

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

Information about a load balancer.

See Also:

  • Method Details

    • loadBalancerArn

      public final String loadBalancerArn()

      The Amazon Resource Name (ARN) of the load balancer.

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

    • dnsName

      public final String dnsName()

      The public DNS name of the load balancer.

      Returns:
      The public DNS name of the load balancer.

    • canonicalHostedZoneId

      public final String canonicalHostedZoneId()

      The ID of the Amazon Route 53 hosted zone associated with the load balancer.

      Returns:
      The ID of the Amazon Route 53 hosted zone associated with the load balancer.

    • createdTime

      public final Instant createdTime()

      The date and time the load balancer was created.

      Returns:
      The date and time the load balancer was created.

    • loadBalancerName

      public final String loadBalancerName()

      The name of the load balancer.

      Returns:
      The name of the load balancer.

    • scheme

      public final LoadBalancerSchemeEnum scheme()

      The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.

      The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.

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

      Returns:
      The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.

      The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.

      See Also:

    • schemeAsString

      public final String schemeAsString()

      The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.

      The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.

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

      Returns:
      The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.

      The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.

      See Also:

    • vpcId

      public final String vpcId()

      The ID of the VPC for the load balancer.

      Returns:
      The ID of the VPC for the load balancer.

    • state

      public final LoadBalancerState state()

      The state of the load balancer.

      Returns:
      The state of the load balancer.

    • type

      public final LoadBalancerTypeEnum type()

      The type of load balancer.

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

      Returns:
      The type of load balancer.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of load balancer.

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

      Returns:
      The type of load balancer.
      See Also:

    • hasAvailabilityZones

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

    • availabilityZones

      public final List<AvailabilityZone> availabilityZones()

      The subnets for the load balancer.

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

      Returns:
      The subnets for the load balancer.

    • hasSecurityGroups

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

    • securityGroups

      public final List<String> securityGroups()

      The IDs of the security groups for the load balancer.

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

      Returns:
      The IDs of the security groups for the load balancer.

    • ipAddressType

      public final IpAddressType ipAddressType()

      The type of IP addresses used for public or private connections by the subnets attached to your load balancer.

      [Application Load Balancers] The possible values are ipv4 (IPv4 addresses), dualstack (IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 (public IPv6 addresses and private IPv4 and IPv6 addresses).

      [Network Load Balancers and Gateway Load Balancers] The possible values are ipv4 (IPv4 addresses) and dualstack (IPv4 and IPv6 addresses).

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

      Returns:
      The type of IP addresses used for public or private connections by the subnets attached to your load balancer.

      [Application Load Balancers] The possible values are ipv4 (IPv4 addresses), dualstack (IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 (public IPv6 addresses and private IPv4 and IPv6 addresses).

      [Network Load Balancers and Gateway Load Balancers] The possible values are ipv4 (IPv4 addresses) and dualstack (IPv4 and IPv6 addresses).

      See Also:

    • ipAddressTypeAsString

      public final String ipAddressTypeAsString()

      The type of IP addresses used for public or private connections by the subnets attached to your load balancer.

      [Application Load Balancers] The possible values are ipv4 (IPv4 addresses), dualstack (IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 (public IPv6 addresses and private IPv4 and IPv6 addresses).

      [Network Load Balancers and Gateway Load Balancers] The possible values are ipv4 (IPv4 addresses) and dualstack (IPv4 and IPv6 addresses).

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

      Returns:
      The type of IP addresses used for public or private connections by the subnets attached to your load balancer.

      [Application Load Balancers] The possible values are ipv4 (IPv4 addresses), dualstack (IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 (public IPv6 addresses and private IPv4 and IPv6 addresses).

      [Network Load Balancers and Gateway Load Balancers] The possible values are ipv4 (IPv4 addresses) and dualstack (IPv4 and IPv6 addresses).

      See Also:

    • customerOwnedIpv4Pool

      public final String customerOwnedIpv4Pool()

      [Application Load Balancers on Outposts] The ID of the customer-owned address pool.

      Returns:
      [Application Load Balancers on Outposts] The ID of the customer-owned address pool.

    • enforceSecurityGroupInboundRulesOnPrivateLinkTraffic

      public final String enforceSecurityGroupInboundRulesOnPrivateLinkTraffic()

      Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through Amazon Web Services PrivateLink.

      Returns:
      Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through Amazon Web Services PrivateLink.

    • enablePrefixForIpv6SourceNat

      public final EnablePrefixForIpv6SourceNatEnum enablePrefixForIpv6SourceNat()

      [Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT. The IP address type must be dualstack. The default value is off.

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

      Returns:
      [Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT. The IP address type must be dualstack. The default value is off.
      See Also:

    • enablePrefixForIpv6SourceNatAsString

      public final String enablePrefixForIpv6SourceNatAsString()

      [Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT. The IP address type must be dualstack. The default value is off.

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

      Returns:
      [Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT. The IP address type must be dualstack. The default value is off.
      See Also:

    • ipamPools

      public final IpamPools ipamPools()

      [Application Load Balancers] The IPAM pool in use by the load balancer, if configured.

      Returns:
      [Application Load Balancers] The IPAM pool in use by the load balancer, if configured.

    • toBuilder

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

    • builder

      public static LoadBalancer.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.