software.amazon.awssdk.services.lightsail.model

Class LoadBalancer

java.lang.Object

software.amazon.awssdk.services.lightsail.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>

Describes the Lightsail 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
String	arn() The Amazon Resource Name (ARN) of the load balancer.
static LoadBalancer.Builder	builder()
Map<LoadBalancerAttributeName,String>	configurationOptions() A string to string map of the configuration options for your load balancer.
Map<String,String>	configurationOptionsAsStrings() A string to string map of the configuration options for your load balancer.
Instant	createdAt() The date when your load balancer was created.
String	dnsName() The DNS name of your Lightsail load balancer.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	healthCheckPath() The path you specified to perform your health checks.
List<InstanceHealthSummary>	instanceHealthSummary() An array of InstanceHealthSummary objects describing the health of the load balancer.
Integer	instancePort() The port where the load balancer will direct traffic to your Lightsail instances.
ResourceLocation	location() The AWS Region where your load balancer was created (e.g., us-east-2a).
String	name() The name of the load balancer (e.g., my-load-balancer).
LoadBalancerProtocol	protocol() The protocol you have enabled for your load balancer.
String	protocolAsString() The protocol you have enabled for your load balancer.
List<Integer>	publicPorts() An array of public port settings for your load balancer.
ResourceType	resourceType() The resource type (e.g., LoadBalancer.
String	resourceTypeAsString() The resource type (e.g., LoadBalancer.
List<SdkField<?>>	sdkFields()
static Class<? extends LoadBalancer.Builder>	serializableBuilderClass()
LoadBalancerState	state() The status of your load balancer.
String	stateAsString() The status of your load balancer.
String	supportCode() The support code.
List<Tag>	tags() The tag keys and optional values for the resource.
List<LoadBalancerTlsCertificateSummary>	tlsCertificateSummaries() An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates.
LoadBalancer.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

name

public String name()

The name of the load balancer (e.g., my-load-balancer).

Returns:

The name of the load balancer (e.g., my-load-balancer).

arn

public String arn()

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

Returns:

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

supportCode

public String supportCode()

The support code. Include this code in your email to support when you have questions about your Lightsail load balancer. This code enables our support team to look up your Lightsail information more easily.

Returns:

The support code. Include this code in your email to support when you have questions about your Lightsail load balancer. This code enables our support team to look up your Lightsail information more easily.

createdAt

public Instant createdAt()

The date when your load balancer was created.

Returns:

The date when your load balancer was created.

location

public ResourceLocation location()

The AWS Region where your load balancer was created (e.g., us-east-2a). Lightsail automatically creates your load balancer across Availability Zones.

Returns:

The AWS Region where your load balancer was created (e.g., us-east-2a). Lightsail automatically creates your load balancer across Availability Zones.

resourceType

public ResourceType resourceType()

The resource type (e.g., LoadBalancer.

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

Returns:

The resource type (e.g., LoadBalancer.

See Also:

ResourceType

resourceTypeAsString

public String resourceTypeAsString()

The resource type (e.g., LoadBalancer.

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

Returns:

The resource type (e.g., LoadBalancer.

See Also:

ResourceType

tags

public List<Tag> tags()

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.

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

Returns:

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.

dnsName

public String dnsName()

The DNS name of your Lightsail load balancer.

Returns:

The DNS name of your Lightsail load balancer.

state

public LoadBalancerState state()

The status of your load balancer. Valid values are below.

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

Returns:

The status of your load balancer. Valid values are below.

See Also:

LoadBalancerState

stateAsString

public String stateAsString()

The status of your load balancer. Valid values are below.

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

Returns:

The status of your load balancer. Valid values are below.

See Also:

LoadBalancerState

protocol

public LoadBalancerProtocol protocol()

The protocol you have enabled for your load balancer. Valid values are below.

You can't just have HTTP_HTTPS, but you can have just HTTP.

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

Returns:

The protocol you have enabled for your load balancer. Valid values are below.

You can't just have HTTP_HTTPS, but you can have just HTTP.

See Also:

LoadBalancerProtocol

protocolAsString

public String protocolAsString()

The protocol you have enabled for your load balancer. Valid values are below.

You can't just have HTTP_HTTPS, but you can have just HTTP.

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

Returns:

The protocol you have enabled for your load balancer. Valid values are below.

You can't just have HTTP_HTTPS, but you can have just HTTP.

See Also:

LoadBalancerProtocol

publicPorts

public List<Integer> publicPorts()

An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.

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

Returns:

An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.

healthCheckPath

public String healthCheckPath()

The path you specified to perform your health checks. If no path is specified, the load balancer tries to make a request to the default (root) page.

Returns:

The path you specified to perform your health checks. If no path is specified, the load balancer tries to make a request to the default (root) page.

instancePort

public Integer instancePort()

The port where the load balancer will direct traffic to your Lightsail instances. For HTTP traffic, it's port 80. For HTTPS traffic, it's port 443.

Returns:

The port where the load balancer will direct traffic to your Lightsail instances. For HTTP traffic, it's port 80. For HTTPS traffic, it's port 443.

instanceHealthSummary

public List<InstanceHealthSummary> instanceHealthSummary()

An array of InstanceHealthSummary objects describing the health of the load balancer.

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

Returns:

An array of InstanceHealthSummary objects describing the health of the load balancer.

tlsCertificateSummaries

public List<LoadBalancerTlsCertificateSummary> tlsCertificateSummaries()

An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates. For example, if true, the certificate is attached to the load balancer.

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

Returns:

An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates. For example, if true, the certificate is attached to the load balancer.

configurationOptions

public Map<LoadBalancerAttributeName,String> configurationOptions()

A string to string map of the configuration options for your load balancer. Valid values are listed below.

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

Returns:

A string to string map of the configuration options for your load balancer. Valid values are listed below.

configurationOptionsAsStrings

public Map<String,String> configurationOptionsAsStrings()

A string to string map of the configuration options for your load balancer. Valid values are listed below.

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

Returns:

A string to string map of the configuration options for your load balancer. Valid values are listed below.

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.