software.amazon.awssdk.services.elasticloadbalancingv2.model

Class LoadBalancer

java.lang.Object

software.amazon.awssdk.services.elasticloadbalancingv2.model.LoadBalancer

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<LoadBalancer.Builder,LoadBalancer>

@Generated(value="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 and Description
static interface	LoadBalancer.Builder

Method Summary

Modifier and Type	Method and Description
List<AvailabilityZone>	availabilityZones() The Availability Zones 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	dnsName() The public DNS name of the load balancer.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
IpAddressType	ipAddressType() The type of IP addresses used by the subnets for your load balancer.
String	ipAddressTypeAsString() The type of IP addresses used by the subnets for 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.
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

loadBalancerArn

public String loadBalancerArn()

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

Returns:

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

dnsName

public String dnsName()

The public DNS name of the load balancer.

Returns:

The public DNS name of the load balancer.

canonicalHostedZoneId

public 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 Instant createdTime()

The date and time the load balancer was created.

Returns:

The date and time the load balancer was created.

loadBalancerName

public String loadBalancerName()

The name of the load balancer.

Returns:

The name of the load balancer.

scheme

public 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 only route requests 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 only route requests from clients with access to the VPC for the load balancer.

See Also:

LoadBalancerSchemeEnum

schemeAsString

public 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 only route requests 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 only route requests from clients with access to the VPC for the load balancer.

See Also:

LoadBalancerSchemeEnum

vpcId

public String vpcId()

The ID of the VPC for the load balancer.

Returns:

The ID of the VPC for the load balancer.

state

public LoadBalancerState state()

The state of the load balancer.

Returns:

The state of the load balancer.

type

public 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 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

availabilityZones

public List<AvailabilityZone> availabilityZones()

The Availability Zones for the load balancer.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The Availability Zones for the load balancer.

securityGroups

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

Returns:

The IDs of the security groups for the load balancer.

ipAddressType

public IpAddressType ipAddressType()

The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for 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 by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).

See Also:

IpAddressType

ipAddressTypeAsString

public String ipAddressTypeAsString()

The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for 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 by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).

See Also:

IpAddressType

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

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