LoadBalancer (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.lightsail.model.LoadBalancer

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class LoadBalancer
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes the Lightsail load balancer.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

LoadBalancer()

Constructors
Constructor and Description
`LoadBalancer()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LoadBalancer`	`addConfigurationOptionsEntry(String key, String value)`
`LoadBalancer`	`clearConfigurationOptionsEntries()` Removes all the entries added into ConfigurationOptions.
`LoadBalancer`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the load balancer.
`Map<String,String>`	`getConfigurationOptions()` A string to string map of the configuration options for your load balancer.
`Date`	`getCreatedAt()` The date when your load balancer was created.
`String`	`getDnsName()` The DNS name of your Lightsail load balancer.
`String`	`getHealthCheckPath()` The path you specified to perform your health checks.
`List<InstanceHealthSummary>`	`getInstanceHealthSummary()` An array of InstanceHealthSummary objects describing the health of the load balancer.
`Integer`	`getInstancePort()` The instance port where the load balancer is listening.
`ResourceLocation`	`getLocation()` The AWS Region and Availability Zone where your load balancer was created (e.g., `us-east-2a`).
`String`	`getName()` The name of the load balancer (e.g., `my-load-balancer`).
`String`	`getProtocol()` The protocol you have enabled for your load balancer.
`List<Integer>`	`getPublicPorts()` An array of public port settings for your load balancer.
`String`	`getResourceType()` The resource type (e.g., `LoadBalancer`.
`String`	`getState()` The status of your load balancer.
`String`	`getSupportCode()` The support code.
`List<LoadBalancerTlsCertificateSummary>`	`getTlsCertificateSummaries()` An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the TLS/SSL certificates.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the load balancer.
`void`	`setConfigurationOptions(Map<String,String> configurationOptions)` A string to string map of the configuration options for your load balancer.
`void`	`setCreatedAt(Date createdAt)` The date when your load balancer was created.
`void`	`setDnsName(String dnsName)` The DNS name of your Lightsail load balancer.
`void`	`setHealthCheckPath(String healthCheckPath)` The path you specified to perform your health checks.
`void`	`setInstanceHealthSummary(Collection<InstanceHealthSummary> instanceHealthSummary)` An array of InstanceHealthSummary objects describing the health of the load balancer.
`void`	`setInstancePort(Integer instancePort)` The instance port where the load balancer is listening.
`void`	`setLocation(ResourceLocation location)` The AWS Region and Availability Zone where your load balancer was created (e.g., `us-east-2a`).
`void`	`setName(String name)` The name of the load balancer (e.g., `my-load-balancer`).
`void`	`setProtocol(String protocol)` The protocol you have enabled for your load balancer.
`void`	`setPublicPorts(Collection<Integer> publicPorts)` An array of public port settings for your load balancer.
`void`	`setResourceType(String resourceType)` The resource type (e.g., `LoadBalancer`.
`void`	`setState(String state)` The status of your load balancer.
`void`	`setSupportCode(String supportCode)` The support code.
`void`	`setTlsCertificateSummaries(Collection<LoadBalancerTlsCertificateSummary> tlsCertificateSummaries)` An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the TLS/SSL certificates.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`LoadBalancer`	`withArn(String arn)` The Amazon Resource Name (ARN) of the load balancer.
`LoadBalancer`	`withConfigurationOptions(Map<String,String> configurationOptions)` A string to string map of the configuration options for your load balancer.
`LoadBalancer`	`withCreatedAt(Date createdAt)` The date when your load balancer was created.
`LoadBalancer`	`withDnsName(String dnsName)` The DNS name of your Lightsail load balancer.
`LoadBalancer`	`withHealthCheckPath(String healthCheckPath)` The path you specified to perform your health checks.
`LoadBalancer`	`withInstanceHealthSummary(Collection<InstanceHealthSummary> instanceHealthSummary)` An array of InstanceHealthSummary objects describing the health of the load balancer.
`LoadBalancer`	`withInstanceHealthSummary(InstanceHealthSummary... instanceHealthSummary)` An array of InstanceHealthSummary objects describing the health of the load balancer.
`LoadBalancer`	`withInstancePort(Integer instancePort)` The instance port where the load balancer is listening.
`LoadBalancer`	`withLocation(ResourceLocation location)` The AWS Region and Availability Zone where your load balancer was created (e.g., `us-east-2a`).
`LoadBalancer`	`withName(String name)` The name of the load balancer (e.g., `my-load-balancer`).
`LoadBalancer`	`withProtocol(LoadBalancerProtocol protocol)` The protocol you have enabled for your load balancer.
`LoadBalancer`	`withProtocol(String protocol)` The protocol you have enabled for your load balancer.
`LoadBalancer`	`withPublicPorts(Collection<Integer> publicPorts)` An array of public port settings for your load balancer.
`LoadBalancer`	`withPublicPorts(Integer... publicPorts)` An array of public port settings for your load balancer.
`LoadBalancer`	`withResourceType(ResourceType resourceType)` The resource type (e.g., `LoadBalancer`.
`LoadBalancer`	`withResourceType(String resourceType)` The resource type (e.g., `LoadBalancer`.
`LoadBalancer`	`withState(LoadBalancerState state)` The status of your load balancer.
`LoadBalancer`	`withState(String state)` The status of your load balancer.
`LoadBalancer`	`withSupportCode(String supportCode)` The support code.
`LoadBalancer`	`withTlsCertificateSummaries(Collection<LoadBalancerTlsCertificateSummary> tlsCertificateSummaries)` An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the TLS/SSL certificates.
`LoadBalancer`	`withTlsCertificateSummaries(LoadBalancerTlsCertificateSummary... tlsCertificateSummaries)` An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the TLS/SSL certificates.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - LoadBalancer
```
public LoadBalancer()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the load balancer (e.g., my-load-balancer).
    
    Parameters:
    
    name - The name of the load balancer (e.g., my-load-balancer).
  - getName
```
public String getName()
```
    The name of the load balancer (e.g., my-load-balancer).
    
    Returns:
    
    The name of the load balancer (e.g., my-load-balancer).
  - withName
```
public LoadBalancer withName(String name)
```
    The name of the load balancer (e.g., my-load-balancer).
    
    Parameters:
    
    name - The name of the load balancer (e.g., my-load-balancer).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the load balancer.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the load balancer.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the load balancer.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the load balancer.
  - withArn
```
public LoadBalancer withArn(String arn)
```
    The Amazon Resource Name (ARN) of the load balancer.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the load balancer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSupportCode
```
public void setSupportCode(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.
    
    Parameters:
    
    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.
  - getSupportCode
```
public String getSupportCode()
```
    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.
  - withSupportCode
```
public LoadBalancer withSupportCode(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The date when your load balancer was created.
    
    Parameters:
    
    createdAt - The date when your load balancer was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The date when your load balancer was created.
    
    Returns:
    
    The date when your load balancer was created.
  - withCreatedAt
```
public LoadBalancer withCreatedAt(Date createdAt)
```
    The date when your load balancer was created.
    
    Parameters:
    
    createdAt - The date when your load balancer was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLocation
```
public void setLocation(ResourceLocation location)
```
    The AWS Region and Availability Zone where your load balancer was created (e.g., us-east-2a).
    
    Parameters:
    
    location - The AWS Region and Availability Zone where your load balancer was created (e.g., us-east-2a).
  - getLocation
```
public ResourceLocation getLocation()
```
    The AWS Region and Availability Zone where your load balancer was created (e.g., us-east-2a).
    
    Returns:
    
    The AWS Region and Availability Zone where your load balancer was created (e.g., us-east-2a ).
  - withLocation
```
public LoadBalancer withLocation(ResourceLocation location)
```
    The AWS Region and Availability Zone where your load balancer was created (e.g., us-east-2a).
    
    Parameters:
    
    location - The AWS Region and Availability Zone where your load balancer was created (e.g., us-east-2a).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceType
```
public void setResourceType(String resourceType)
```
    The resource type (e.g., LoadBalancer.
    
    Parameters:
    
    resourceType - The resource type (e.g., LoadBalancer.
    
    See Also:
    
    ResourceType
  - getResourceType
```
public String getResourceType()
```
    The resource type (e.g., LoadBalancer.
    
    Returns:
    
    The resource type (e.g., LoadBalancer.
    
    See Also:
    
    ResourceType
  - withResourceType
```
public LoadBalancer withResourceType(String resourceType)
```
    The resource type (e.g., LoadBalancer.
    
    Parameters:
    
    resourceType - The resource type (e.g., LoadBalancer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResourceType
  - withResourceType
```
public LoadBalancer withResourceType(ResourceType resourceType)
```
    The resource type (e.g., LoadBalancer.
    
    Parameters:
    
    resourceType - The resource type (e.g., LoadBalancer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResourceType
  - setDnsName
```
public void setDnsName(String dnsName)
```
    The DNS name of your Lightsail load balancer.
    
    Parameters:
    
    dnsName - The DNS name of your Lightsail load balancer.
  - getDnsName
```
public String getDnsName()
```
    The DNS name of your Lightsail load balancer.
    
    Returns:
    
    The DNS name of your Lightsail load balancer.
  - withDnsName
```
public LoadBalancer withDnsName(String dnsName)
```
    The DNS name of your Lightsail load balancer.
    
    Parameters:
    
    dnsName - The DNS name of your Lightsail load balancer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    The status of your load balancer. Valid values are below.
    
    Parameters:
    
    state - The status of your load balancer. Valid values are below.
    
    See Also:
    
    LoadBalancerState
  - getState
```
public String getState()
```
    The status of your load balancer. Valid values are below.
    
    Returns:
    
    The status of your load balancer. Valid values are below.
    
    See Also:
    
    LoadBalancerState
  - withState
```
public LoadBalancer withState(String state)
```
    The status of your load balancer. Valid values are below.
    
    Parameters:
    
    state - The status of your load balancer. Valid values are below.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LoadBalancerState
  - withState
```
public LoadBalancer withState(LoadBalancerState state)
```
    The status of your load balancer. Valid values are below.
    
    Parameters:
    
    state - The status of your load balancer. Valid values are below.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LoadBalancerState
  - setProtocol
```
public void setProtocol(String protocol)
```
    The protocol you have enabled for your load balancer. Valid values are below.
    
    Parameters:
    
    protocol - The protocol you have enabled for your load balancer. Valid values are below.
    
    See Also:
    
    LoadBalancerProtocol
  - getProtocol
```
public String getProtocol()
```
    The protocol you have enabled for your load balancer. Valid values are below.
    
    Returns:
    
    The protocol you have enabled for your load balancer. Valid values are below.
    
    See Also:
    
    LoadBalancerProtocol
  - withProtocol
```
public LoadBalancer withProtocol(String protocol)
```
    The protocol you have enabled for your load balancer. Valid values are below.
    
    Parameters:
    
    protocol - The protocol you have enabled for your load balancer. Valid values are below.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LoadBalancerProtocol
  - withProtocol
```
public LoadBalancer withProtocol(LoadBalancerProtocol protocol)
```
    The protocol you have enabled for your load balancer. Valid values are below.
    
    Parameters:
    
    protocol - The protocol you have enabled for your load balancer. Valid values are below.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LoadBalancerProtocol
  - getPublicPorts
```
public List<Integer> getPublicPorts()
```
    An array of public port settings for your load balancer.
    
    Returns:
    
    An array of public port settings for your load balancer.
  - setPublicPorts
```
public void setPublicPorts(Collection<Integer> publicPorts)
```
    An array of public port settings for your load balancer.
    
    Parameters:
    
    publicPorts - An array of public port settings for your load balancer.
  - withPublicPorts
```
public LoadBalancer withPublicPorts(Integer... publicPorts)
```
    An array of public port settings for your load balancer.
    
    NOTE: This method appends the values to the existing list (if any). Use setPublicPorts(java.util.Collection) or withPublicPorts(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    publicPorts - An array of public port settings for your load balancer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withPublicPorts
```
public LoadBalancer withPublicPorts(Collection<Integer> publicPorts)
```
    An array of public port settings for your load balancer.
    
    Parameters:
    
    publicPorts - An array of public port settings for your load balancer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHealthCheckPath
```
public void setHealthCheckPath(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.
    
    Parameters:
    
    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.
  - getHealthCheckPath
```
public String getHealthCheckPath()
```
    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.
  - withHealthCheckPath
```
public LoadBalancer withHealthCheckPath(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstancePort
```
public void setInstancePort(Integer instancePort)
```
    The instance port where the load balancer is listening.
    
    Parameters:
    
    instancePort - The instance port where the load balancer is listening.
  - getInstancePort
```
public Integer getInstancePort()
```
    The instance port where the load balancer is listening.
    
    Returns:
    
    The instance port where the load balancer is listening.
  - withInstancePort
```
public LoadBalancer withInstancePort(Integer instancePort)
```
    The instance port where the load balancer is listening.
    
    Parameters:
    
    instancePort - The instance port where the load balancer is listening.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getInstanceHealthSummary
```
public List<InstanceHealthSummary> getInstanceHealthSummary()
```
    An array of InstanceHealthSummary objects describing the health of the load balancer.
    
    Returns:
    
    An array of InstanceHealthSummary objects describing the health of the load balancer.
  - setInstanceHealthSummary
```
public void setInstanceHealthSummary(Collection<InstanceHealthSummary> instanceHealthSummary)
```
    An array of InstanceHealthSummary objects describing the health of the load balancer.
    
    Parameters:
    
    instanceHealthSummary - An array of InstanceHealthSummary objects describing the health of the load balancer.
  - withInstanceHealthSummary
```
public LoadBalancer withInstanceHealthSummary(InstanceHealthSummary... instanceHealthSummary)
```
    An array of InstanceHealthSummary objects describing the health of the load balancer.
    
    NOTE: This method appends the values to the existing list (if any). Use setInstanceHealthSummary(java.util.Collection) or withInstanceHealthSummary(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    instanceHealthSummary - An array of InstanceHealthSummary objects describing the health of the load balancer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInstanceHealthSummary
```
public LoadBalancer withInstanceHealthSummary(Collection<InstanceHealthSummary> instanceHealthSummary)
```
    An array of InstanceHealthSummary objects describing the health of the load balancer.
    
    Parameters:
    
    instanceHealthSummary - An array of InstanceHealthSummary objects describing the health of the load balancer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTlsCertificateSummaries
```
public List<LoadBalancerTlsCertificateSummary> getTlsCertificateSummaries()
```
    An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the TLS/SSL certificates.
    
    Returns:
    
    An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the TLS/SSL certificates.
  - setTlsCertificateSummaries
```
public void setTlsCertificateSummaries(Collection<LoadBalancerTlsCertificateSummary> tlsCertificateSummaries)
```
    An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the TLS/SSL certificates.
    
    Parameters:
    
    tlsCertificateSummaries - An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the TLS/SSL certificates.
  - withTlsCertificateSummaries
```
public LoadBalancer withTlsCertificateSummaries(LoadBalancerTlsCertificateSummary... tlsCertificateSummaries)
```
    An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the TLS/SSL certificates.
    
    NOTE: This method appends the values to the existing list (if any). Use setTlsCertificateSummaries(java.util.Collection) or withTlsCertificateSummaries(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tlsCertificateSummaries - An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the TLS/SSL certificates.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTlsCertificateSummaries
```
public LoadBalancer withTlsCertificateSummaries(Collection<LoadBalancerTlsCertificateSummary> tlsCertificateSummaries)
```
    An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the TLS/SSL certificates.
    
    Parameters:
    
    tlsCertificateSummaries - An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the TLS/SSL certificates.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getConfigurationOptions
```
public Map<String,String> getConfigurationOptions()
```
    A string to string map of the configuration options for your load balancer. Valid values are listed below.
    
    Returns:
    
    A string to string map of the configuration options for your load balancer. Valid values are listed below.
  - setConfigurationOptions
```
public void setConfigurationOptions(Map<String,String> configurationOptions)
```
    A string to string map of the configuration options for your load balancer. Valid values are listed below.
    
    Parameters:
    
    configurationOptions - A string to string map of the configuration options for your load balancer. Valid values are listed below.
  - withConfigurationOptions
```
public LoadBalancer withConfigurationOptions(Map<String,String> configurationOptions)
```
    A string to string map of the configuration options for your load balancer. Valid values are listed below.
    
    Parameters:
    
    configurationOptions - A string to string map of the configuration options for your load balancer. Valid values are listed below.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addConfigurationOptionsEntry
```
public LoadBalancer addConfigurationOptionsEntry(String key,
                                                 String value)
```
  - clearConfigurationOptionsEntries
```
public LoadBalancer clearConfigurationOptionsEntries()
```
    Removes all the entries added into ConfigurationOptions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public LoadBalancer clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class LoadBalancer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LoadBalancer

Method Detail

setName

getName

withName

setArn

getArn

withArn

setSupportCode

getSupportCode

withSupportCode

setCreatedAt

getCreatedAt

withCreatedAt

setLocation

getLocation

withLocation

setResourceType

getResourceType

withResourceType

withResourceType

setDnsName

getDnsName

withDnsName

setState

getState

withState

withState

setProtocol

getProtocol

withProtocol

withProtocol

getPublicPorts

setPublicPorts

withPublicPorts

withPublicPorts

setHealthCheckPath

getHealthCheckPath

withHealthCheckPath

setInstancePort

getInstancePort

withInstancePort

getInstanceHealthSummary

setInstanceHealthSummary

withInstanceHealthSummary

withInstanceHealthSummary

getTlsCertificateSummaries

setTlsCertificateSummaries

withTlsCertificateSummaries

withTlsCertificateSummaries

getConfigurationOptions

setConfigurationOptions

withConfigurationOptions

addConfigurationOptionsEntry

clearConfigurationOptionsEntries

toString

equals

hashCode

clone

marshall