@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class LoadBalancer extends Object implements Serializable, Cloneable, StructuredPojo
Describes a load balancer.
Constructor and Description |
---|
LoadBalancer() |
Modifier and Type | Method and Description |
---|---|
LoadBalancer |
addConfigurationOptionsEntry(String key,
String value)
Add a single ConfigurationOptions entry
|
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.
|
Boolean |
getHttpsRedirectionEnabled()
A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.
|
List<InstanceHealthSummary> |
getInstanceHealthSummary()
An array of InstanceHealthSummary objects describing the health of the load balancer.
|
Integer |
getInstancePort()
The port where the load balancer will direct traffic to your Lightsail instances.
|
String |
getIpAddressType()
The IP address type of the load balancer.
|
ResourceLocation |
getLocation()
The AWS Region where your load balancer was created (
us-east-2a ). |
String |
getName()
The name of the load balancer (
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 (
LoadBalancer . |
String |
getState()
The status of your load balancer.
|
String |
getSupportCode()
The support code.
|
List<Tag> |
getTags()
The tag keys and optional values for the resource.
|
List<LoadBalancerTlsCertificateSummary> |
getTlsCertificateSummaries()
An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS
certificates.
|
String |
getTlsPolicyName()
The name of the TLS security policy for the load balancer.
|
int |
hashCode() |
Boolean |
isHttpsRedirectionEnabled()
A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.
|
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 |
setHttpsRedirectionEnabled(Boolean httpsRedirectionEnabled)
A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.
|
void |
setInstanceHealthSummary(Collection<InstanceHealthSummary> instanceHealthSummary)
An array of InstanceHealthSummary objects describing the health of the load balancer.
|
void |
setInstancePort(Integer instancePort)
The port where the load balancer will direct traffic to your Lightsail instances.
|
void |
setIpAddressType(String ipAddressType)
The IP address type of the load balancer.
|
void |
setLocation(ResourceLocation location)
The AWS Region where your load balancer was created (
us-east-2a ). |
void |
setName(String name)
The name of the load balancer (
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 (
LoadBalancer . |
void |
setState(String state)
The status of your load balancer.
|
void |
setSupportCode(String supportCode)
The support code.
|
void |
setTags(Collection<Tag> tags)
The tag keys and optional values for the resource.
|
void |
setTlsCertificateSummaries(Collection<LoadBalancerTlsCertificateSummary> tlsCertificateSummaries)
An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS
certificates.
|
void |
setTlsPolicyName(String tlsPolicyName)
The name of the TLS security policy for the load balancer.
|
String |
toString()
Returns a string representation of this object.
|
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 |
withHttpsRedirectionEnabled(Boolean httpsRedirectionEnabled)
A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.
|
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 port where the load balancer will direct traffic to your Lightsail instances.
|
LoadBalancer |
withIpAddressType(IpAddressType ipAddressType)
The IP address type of the load balancer.
|
LoadBalancer |
withIpAddressType(String ipAddressType)
The IP address type of the load balancer.
|
LoadBalancer |
withLocation(ResourceLocation location)
The AWS Region where your load balancer was created (
us-east-2a ). |
LoadBalancer |
withName(String name)
The name of the load balancer (
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 (
LoadBalancer . |
LoadBalancer |
withResourceType(String resourceType)
The resource type (
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 |
withTags(Collection<Tag> tags)
The tag keys and optional values for the resource.
|
LoadBalancer |
withTags(Tag... tags)
The tag keys and optional values for the resource.
|
LoadBalancer |
withTlsCertificateSummaries(Collection<LoadBalancerTlsCertificateSummary> tlsCertificateSummaries)
An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS
certificates.
|
LoadBalancer |
withTlsCertificateSummaries(LoadBalancerTlsCertificateSummary... tlsCertificateSummaries)
An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS
certificates.
|
LoadBalancer |
withTlsPolicyName(String tlsPolicyName)
The name of the TLS security policy for the load balancer.
|
public void setName(String name)
The name of the load balancer (my-load-balancer
).
name
- The name of the load balancer (my-load-balancer
).public String getName()
The name of the load balancer (my-load-balancer
).
my-load-balancer
).public LoadBalancer withName(String name)
The name of the load balancer (my-load-balancer
).
name
- The name of the load balancer (my-load-balancer
).public void setArn(String arn)
The Amazon Resource Name (ARN) of the load balancer.
arn
- The Amazon Resource Name (ARN) of the load balancer.public String getArn()
The Amazon Resource Name (ARN) of the load balancer.
public LoadBalancer withArn(String arn)
The Amazon Resource Name (ARN) of the load balancer.
arn
- The Amazon Resource Name (ARN) of the load balancer.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.
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.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.
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.
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.public void setCreatedAt(Date createdAt)
The date when your load balancer was created.
createdAt
- The date when your load balancer was created.public Date getCreatedAt()
The date when your load balancer was created.
public LoadBalancer withCreatedAt(Date createdAt)
The date when your load balancer was created.
createdAt
- The date when your load balancer was created.public void setLocation(ResourceLocation location)
The AWS Region where your load balancer was created (us-east-2a
). Lightsail automatically creates
your load balancer across Availability Zones.
location
- The AWS Region where your load balancer was created (us-east-2a
). Lightsail automatically
creates your load balancer across Availability Zones.public ResourceLocation getLocation()
The AWS Region where your load balancer was created (us-east-2a
). Lightsail automatically creates
your load balancer across Availability Zones.
us-east-2a
). Lightsail automatically
creates your load balancer across Availability Zones.public LoadBalancer withLocation(ResourceLocation location)
The AWS Region where your load balancer was created (us-east-2a
). Lightsail automatically creates
your load balancer across Availability Zones.
location
- The AWS Region where your load balancer was created (us-east-2a
). Lightsail automatically
creates your load balancer across Availability Zones.public void setResourceType(String resourceType)
The resource type (LoadBalancer
.
resourceType
- The resource type (LoadBalancer
.ResourceType
public String getResourceType()
The resource type (LoadBalancer
.
LoadBalancer
.ResourceType
public LoadBalancer withResourceType(String resourceType)
The resource type (LoadBalancer
.
resourceType
- The resource type (LoadBalancer
.ResourceType
public LoadBalancer withResourceType(ResourceType resourceType)
The resource type (LoadBalancer
.
resourceType
- The resource type (LoadBalancer
.ResourceType
public List<Tag> getTags()
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
public void setTags(Collection<Tag> tags)
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
tags
- The tag keys and optional values for the resource. For more information about tags in Lightsail, see the
Amazon Lightsail
Developer Guide.public LoadBalancer withTags(Tag... tags)
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- The tag keys and optional values for the resource. For more information about tags in Lightsail, see the
Amazon Lightsail
Developer Guide.public LoadBalancer withTags(Collection<Tag> tags)
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
tags
- The tag keys and optional values for the resource. For more information about tags in Lightsail, see the
Amazon Lightsail
Developer Guide.public void setDnsName(String dnsName)
The DNS name of your Lightsail load balancer.
dnsName
- The DNS name of your Lightsail load balancer.public String getDnsName()
The DNS name of your Lightsail load balancer.
public LoadBalancer withDnsName(String dnsName)
The DNS name of your Lightsail load balancer.
dnsName
- The DNS name of your Lightsail load balancer.public void setState(String state)
The status of your load balancer. Valid values are below.
state
- The status of your load balancer. Valid values are below.LoadBalancerState
public String getState()
The status of your load balancer. Valid values are below.
LoadBalancerState
public LoadBalancer withState(String state)
The status of your load balancer. Valid values are below.
state
- The status of your load balancer. Valid values are below.LoadBalancerState
public LoadBalancer withState(LoadBalancerState state)
The status of your load balancer. Valid values are below.
state
- The status of your load balancer. Valid values are below.LoadBalancerState
public void setProtocol(String 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
.
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
.
LoadBalancerProtocol
public String getProtocol()
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
.
You can't just have HTTP_HTTPS
, but you can have just HTTP
.
LoadBalancerProtocol
public LoadBalancer withProtocol(String 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
.
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
.
LoadBalancerProtocol
public LoadBalancer withProtocol(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
.
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
.
LoadBalancerProtocol
public List<Integer> getPublicPorts()
An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.
public void setPublicPorts(Collection<Integer> publicPorts)
An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.
publicPorts
- An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.public LoadBalancer withPublicPorts(Integer... publicPorts)
An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.
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.
publicPorts
- An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.public LoadBalancer withPublicPorts(Collection<Integer> publicPorts)
An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.
publicPorts
- An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.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.
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.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.
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.
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.public void setInstancePort(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.
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.public Integer getInstancePort()
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.
public LoadBalancer withInstancePort(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.
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.public List<InstanceHealthSummary> getInstanceHealthSummary()
An array of InstanceHealthSummary objects describing the health of the load balancer.
public void setInstanceHealthSummary(Collection<InstanceHealthSummary> instanceHealthSummary)
An array of InstanceHealthSummary objects describing the health of the load balancer.
instanceHealthSummary
- An array of InstanceHealthSummary objects describing the health of the load balancer.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.
instanceHealthSummary
- An array of InstanceHealthSummary objects describing the health of the load balancer.public LoadBalancer withInstanceHealthSummary(Collection<InstanceHealthSummary> instanceHealthSummary)
An array of InstanceHealthSummary objects describing the health of the load balancer.
instanceHealthSummary
- An array of InstanceHealthSummary objects describing the health of the load balancer.public List<LoadBalancerTlsCertificateSummary> getTlsCertificateSummaries()
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.
true
, the certificate is attached to the load
balancer.public void setTlsCertificateSummaries(Collection<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.
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.public LoadBalancer withTlsCertificateSummaries(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.
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.
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.public LoadBalancer withTlsCertificateSummaries(Collection<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.
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.public Map<String,String> getConfigurationOptions()
A string to string map of the configuration options for your load balancer. Valid values are listed below.
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.
configurationOptions
- A string to string map of the configuration options for your load balancer. Valid values are listed below.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.
configurationOptions
- A string to string map of the configuration options for your load balancer. Valid values are listed below.public LoadBalancer addConfigurationOptionsEntry(String key, String value)
public LoadBalancer clearConfigurationOptionsEntries()
public void setIpAddressType(String ipAddressType)
The IP address type of the load balancer.
The possible values are ipv4
for IPv4 only, ipv6
for IPv6 only, and
dualstack
for IPv4 and IPv6.
ipAddressType
- The IP address type of the load balancer.
The possible values are ipv4
for IPv4 only, ipv6
for IPv6 only, and
dualstack
for IPv4 and IPv6.
IpAddressType
public String getIpAddressType()
The IP address type of the load balancer.
The possible values are ipv4
for IPv4 only, ipv6
for IPv6 only, and
dualstack
for IPv4 and IPv6.
The possible values are ipv4
for IPv4 only, ipv6
for IPv6 only, and
dualstack
for IPv4 and IPv6.
IpAddressType
public LoadBalancer withIpAddressType(String ipAddressType)
The IP address type of the load balancer.
The possible values are ipv4
for IPv4 only, ipv6
for IPv6 only, and
dualstack
for IPv4 and IPv6.
ipAddressType
- The IP address type of the load balancer.
The possible values are ipv4
for IPv4 only, ipv6
for IPv6 only, and
dualstack
for IPv4 and IPv6.
IpAddressType
public LoadBalancer withIpAddressType(IpAddressType ipAddressType)
The IP address type of the load balancer.
The possible values are ipv4
for IPv4 only, ipv6
for IPv6 only, and
dualstack
for IPv4 and IPv6.
ipAddressType
- The IP address type of the load balancer.
The possible values are ipv4
for IPv4 only, ipv6
for IPv6 only, and
dualstack
for IPv4 and IPv6.
IpAddressType
public void setHttpsRedirectionEnabled(Boolean httpsRedirectionEnabled)
A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.
httpsRedirectionEnabled
- A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.public Boolean getHttpsRedirectionEnabled()
A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.
public LoadBalancer withHttpsRedirectionEnabled(Boolean httpsRedirectionEnabled)
A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.
httpsRedirectionEnabled
- A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.public Boolean isHttpsRedirectionEnabled()
A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.
public void setTlsPolicyName(String tlsPolicyName)
The name of the TLS security policy for the load balancer.
tlsPolicyName
- The name of the TLS security policy for the load balancer.public String getTlsPolicyName()
The name of the TLS security policy for the load balancer.
public LoadBalancer withTlsPolicyName(String tlsPolicyName)
The name of the TLS security policy for the load balancer.
tlsPolicyName
- The name of the TLS security policy for the load balancer.public String toString()
toString
in class Object
Object.toString()
public LoadBalancer clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.