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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface LoadBalancer.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<AvailabilityZone>`	`availabilityZones()`	The subnets for the load balancer.
`static LoadBalancer.Builder`	`builder()`
`String`	`canonicalHostedZoneId()`	The ID of the Amazon Route 53 hosted zone associated with the load balancer.
`Instant`	`createdTime()`	The date and time the load balancer was created.
`String`	`customerOwnedIpv4Pool()`	[Application Load Balancers on Outposts] The ID of the customer-owned address pool.
`String`	`dnsName()`	The public DNS name of the load balancer.
`EnablePrefixForIpv6SourceNatEnum`	`enablePrefixForIpv6SourceNat()`	[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT.
`String`	`enablePrefixForIpv6SourceNatAsString()`	[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT.
`String`	`enforceSecurityGroupInboundRulesOnPrivateLinkTraffic()`	Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through Amazon Web Services PrivateLink.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAvailabilityZones()`	For responses, this returns true if the service returned a value for the AvailabilityZones property.
`int`	`hashCode()`
`boolean`	`hasSecurityGroups()`	For responses, this returns true if the service returned a value for the SecurityGroups property.
`IpAddressType`	`ipAddressType()`	The type of IP addresses used for public or private connections by the subnets attached to your load balancer.
`String`	`ipAddressTypeAsString()`	The type of IP addresses used for public or private connections by the subnets attached to your load balancer.
`String`	`loadBalancerArn()`	The Amazon Resource Name (ARN) of the load balancer.
`String`	`loadBalancerName()`	The name of the load balancer.
`LoadBalancerSchemeEnum`	`scheme()`	The nodes of an Internet-facing load balancer have public IP addresses.
`String`	`schemeAsString()`	The nodes of an Internet-facing load balancer have public IP addresses.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityGroups()`	The IDs of the security groups for the load balancer.
`static Class<? extends LoadBalancer.Builder>`	`serializableBuilderClass()`
`LoadBalancerState`	`state()`	The state of the load balancer.
`LoadBalancer.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`LoadBalancerTypeEnum`	`type()`	The type of load balancer.
`String`	`typeAsString()`	The type of load balancer.
`String`	`vpcId()`	The ID of the VPC for the load balancer.

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
  - 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:
    
    LoadBalancerSchemeEnum
  - 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:
    
    LoadBalancerSchemeEnum
  - 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:
    
    LoadBalancerTypeEnum
  - 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:
    
    LoadBalancerTypeEnum
  - 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:
    
    IpAddressType
  - 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:
    
    IpAddressType
  - 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:
    
    EnablePrefixForIpv6SourceNatEnum
  - 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:
    
    EnablePrefixForIpv6SourceNatEnum
  - toBuilder
```
public LoadBalancer.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<LoadBalancer.Builder,LoadBalancer>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class LoadBalancer

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

loadBalancerArn

dnsName

canonicalHostedZoneId

createdTime

loadBalancerName

scheme

schemeAsString

vpcId

state

type

typeAsString

hasAvailabilityZones

availabilityZones

hasSecurityGroups

securityGroups

ipAddressType

ipAddressTypeAsString

customerOwnedIpv4Pool

enforceSecurityGroupInboundRulesOnPrivateLinkTraffic

enablePrefixForIpv6SourceNat

enablePrefixForIpv6SourceNatAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField