Interface LoadBalancer.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<LoadBalancer.Builder,
,LoadBalancer> SdkBuilder<LoadBalancer.Builder,
,LoadBalancer> SdkPojo
- Enclosing class:
LoadBalancer
-
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the load balancer.configurationOptions
(Map<LoadBalancerAttributeName, String> configurationOptions) A string to string map of the configuration options for your load balancer.configurationOptionsWithStrings
(Map<String, String> configurationOptions) A string to string map of the configuration options for your load balancer.The date when your load balancer was created.The DNS name of your Lightsail load balancer.healthCheckPath
(String healthCheckPath) The path you specified to perform your health checks.httpsRedirectionEnabled
(Boolean httpsRedirectionEnabled) A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.instanceHealthSummary
(Collection<InstanceHealthSummary> instanceHealthSummary) An array of InstanceHealthSummary objects describing the health of the load balancer.instanceHealthSummary
(Consumer<InstanceHealthSummary.Builder>... instanceHealthSummary) An array of InstanceHealthSummary objects describing the health of the load balancer.instanceHealthSummary
(InstanceHealthSummary... instanceHealthSummary) An array of InstanceHealthSummary objects describing the health of the load balancer.instancePort
(Integer instancePort) The port where the load balancer will direct traffic to your Lightsail instances.ipAddressType
(String ipAddressType) The IP address type of the load balancer.ipAddressType
(IpAddressType ipAddressType) The IP address type of the load balancer.default LoadBalancer.Builder
location
(Consumer<ResourceLocation.Builder> location) The AWS Region where your load balancer was created (us-east-2a
).location
(ResourceLocation location) The AWS Region where your load balancer was created (us-east-2a
).The name of the load balancer (my-load-balancer
).The protocol you have enabled for your load balancer.protocol
(LoadBalancerProtocol protocol) The protocol you have enabled for your load balancer.publicPorts
(Integer... publicPorts) An array of public port settings for your load balancer.publicPorts
(Collection<Integer> publicPorts) An array of public port settings for your load balancer.resourceType
(String resourceType) The resource type (LoadBalancer
.resourceType
(ResourceType resourceType) The resource type (LoadBalancer
.The status of your load balancer.state
(LoadBalancerState state) The status of your load balancer.supportCode
(String supportCode) The support code.tags
(Collection<Tag> tags) The tag keys and optional values for the resource.tags
(Consumer<Tag.Builder>... tags) The tag keys and optional values for the resource.The tag keys and optional values for the resource.tlsCertificateSummaries
(Collection<LoadBalancerTlsCertificateSummary> tlsCertificateSummaries) An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates.tlsCertificateSummaries
(Consumer<LoadBalancerTlsCertificateSummary.Builder>... tlsCertificateSummaries) An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates.tlsCertificateSummaries
(LoadBalancerTlsCertificateSummary... tlsCertificateSummaries) An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates.tlsPolicyName
(String tlsPolicyName) The name of the TLS security policy for the load balancer.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
name
The name of the load balancer (
my-load-balancer
).- Parameters:
name
- The name of the load balancer (my-load-balancer
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
-
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.
-
location
The AWS Region where your load balancer was created (
us-east-2a
). Lightsail automatically creates your load balancer across Availability Zones.- Parameters:
location
- The AWS Region where your load balancer was created (us-east-2a
). Lightsail automatically creates your load balancer across Availability Zones.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
location
The AWS Region where your load balancer was created (
This is a convenience method that creates an instance of theus-east-2a
). Lightsail automatically creates your load balancer across Availability Zones.ResourceLocation.Builder
avoiding the need to create one manually viaResourceLocation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolocation(ResourceLocation)
.- Parameters:
location
- a consumer that will call methods onResourceLocation.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
resourceType
The resource type (
LoadBalancer
.- Parameters:
resourceType
- The resource type (LoadBalancer
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
resourceType
The resource type (
LoadBalancer
.- Parameters:
resourceType
- The resource type (LoadBalancer
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tags
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
- Parameters:
tags
- The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
- Parameters:
tags
- The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
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:
-
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:
-
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 justHTTP
.- Parameters:
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 justHTTP
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 justHTTP
.- Parameters:
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 justHTTP
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
publicPorts
An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.
- Parameters:
publicPorts
- An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
publicPorts
An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.
- Parameters:
publicPorts
- An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
-
instanceHealthSummary
LoadBalancer.Builder instanceHealthSummary(Consumer<InstanceHealthSummary.Builder>... instanceHealthSummary) An array of InstanceHealthSummary objects describing the health of the load balancer.
This is a convenience method that creates an instance of theInstanceHealthSummary.Builder
avoiding the need to create one manually viaInstanceHealthSummary.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinstanceHealthSummary(List<InstanceHealthSummary>)
.- Parameters:
instanceHealthSummary
- a consumer that will call methods onInstanceHealthSummary.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tlsCertificateSummaries
LoadBalancer.Builder tlsCertificateSummaries(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.- Parameters:
tlsCertificateSummaries
- An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates. For example, iftrue
, the certificate is attached to the load balancer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tlsCertificateSummaries
LoadBalancer.Builder tlsCertificateSummaries(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.- Parameters:
tlsCertificateSummaries
- An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates. For example, iftrue
, the certificate is attached to the load balancer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tlsCertificateSummaries
LoadBalancer.Builder tlsCertificateSummaries(Consumer<LoadBalancerTlsCertificateSummary.Builder>... tlsCertificateSummaries) An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates. For example, if
This is a convenience method that creates an instance of thetrue
, the certificate is attached to the load balancer.LoadBalancerTlsCertificateSummary.Builder
avoiding the need to create one manually viaLoadBalancerTlsCertificateSummary.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totlsCertificateSummaries(List<LoadBalancerTlsCertificateSummary>)
.- Parameters:
tlsCertificateSummaries
- a consumer that will call methods onLoadBalancerTlsCertificateSummary.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
configurationOptionsWithStrings
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.
-
configurationOptions
LoadBalancer.Builder configurationOptions(Map<LoadBalancerAttributeName, 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.
-
ipAddressType
The IP address type of the load balancer.
The possible values are
ipv4
for IPv4 only, anddualstack
for IPv4 and IPv6.- Parameters:
ipAddressType
- The IP address type of the load balancer.The possible values are
ipv4
for IPv4 only, anddualstack
for IPv4 and IPv6.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
ipAddressType
The IP address type of the load balancer.
The possible values are
ipv4
for IPv4 only, anddualstack
for IPv4 and IPv6.- Parameters:
ipAddressType
- The IP address type of the load balancer.The possible values are
ipv4
for IPv4 only, anddualstack
for IPv4 and IPv6.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
httpsRedirectionEnabled
A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.
- Parameters:
httpsRedirectionEnabled
- A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tlsPolicyName
The name of the TLS security policy for the load balancer.
- Parameters:
tlsPolicyName
- The name of the TLS security policy for the load balancer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-