LoadBalancer.Builder (AWS Java SDK :: Services :: Amazon Lightsail 2.18.21 API)

All Superinterfaces:

Buildable, CopyableBuilder<LoadBalancer.Builder,LoadBalancer>, SdkBuilder<LoadBalancer.Builder,LoadBalancer>, SdkPojo

Enclosing class:

LoadBalancer
```
public static interface LoadBalancer.Builder
extends SdkPojo, CopyableBuilder<LoadBalancer.Builder,LoadBalancer>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`LoadBalancer.Builder`	`arn(String arn)` The Amazon Resource Name (ARN) of the load balancer.
`LoadBalancer.Builder`	`configurationOptions(Map<LoadBalancerAttributeName,String> configurationOptions)` A string to string map of the configuration options for your load balancer.
`LoadBalancer.Builder`	`configurationOptionsWithStrings(Map<String,String> configurationOptions)` A string to string map of the configuration options for your load balancer.
`LoadBalancer.Builder`	`createdAt(Instant createdAt)` The date when your load balancer was created.
`LoadBalancer.Builder`	`dnsName(String dnsName)` The DNS name of your Lightsail load balancer.
`LoadBalancer.Builder`	`healthCheckPath(String healthCheckPath)` The path you specified to perform your health checks.
`LoadBalancer.Builder`	`httpsRedirectionEnabled(Boolean httpsRedirectionEnabled)` A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.
`LoadBalancer.Builder`	`instanceHealthSummary(Collection<InstanceHealthSummary> instanceHealthSummary)` An array of InstanceHealthSummary objects describing the health of the load balancer.
`LoadBalancer.Builder`	`instanceHealthSummary(Consumer<InstanceHealthSummary.Builder>... instanceHealthSummary)` An array of InstanceHealthSummary objects describing the health of the load balancer.
`LoadBalancer.Builder`	`instanceHealthSummary(InstanceHealthSummary... instanceHealthSummary)` An array of InstanceHealthSummary objects describing the health of the load balancer.
`LoadBalancer.Builder`	`instancePort(Integer instancePort)` The port where the load balancer will direct traffic to your Lightsail instances.
`LoadBalancer.Builder`	`ipAddressType(IpAddressType ipAddressType)` The IP address type of the load balancer.
`LoadBalancer.Builder`	`ipAddressType(String 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 (e.g., `us-east-2a`).
`LoadBalancer.Builder`	`location(ResourceLocation location)` The AWS Region where your load balancer was created (e.g., `us-east-2a`).
`LoadBalancer.Builder`	`name(String name)` The name of the load balancer (e.g., `my-load-balancer`).
`LoadBalancer.Builder`	`protocol(LoadBalancerProtocol protocol)` The protocol you have enabled for your load balancer.
`LoadBalancer.Builder`	`protocol(String protocol)` The protocol you have enabled for your load balancer.
`LoadBalancer.Builder`	`publicPorts(Collection<Integer> publicPorts)` An array of public port settings for your load balancer.
`LoadBalancer.Builder`	`publicPorts(Integer... publicPorts)` An array of public port settings for your load balancer.
`LoadBalancer.Builder`	`resourceType(ResourceType resourceType)` The resource type (e.g., `LoadBalancer`.
`LoadBalancer.Builder`	`resourceType(String resourceType)` The resource type (e.g., `LoadBalancer`.
`LoadBalancer.Builder`	`state(LoadBalancerState state)` The status of your load balancer.
`LoadBalancer.Builder`	`state(String state)` The status of your load balancer.
`LoadBalancer.Builder`	`supportCode(String supportCode)` The support code.
`LoadBalancer.Builder`	`tags(Collection<Tag> tags)` The tag keys and optional values for the resource.
`LoadBalancer.Builder`	`tags(Consumer<Tag.Builder>... tags)` The tag keys and optional values for the resource.
`LoadBalancer.Builder`	`tags(Tag... tags)` The tag keys and optional values for the resource.
`LoadBalancer.Builder`	`tlsCertificateSummaries(Collection<LoadBalancerTlsCertificateSummary> tlsCertificateSummaries)` An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates.
`LoadBalancer.Builder`	`tlsCertificateSummaries(Consumer<LoadBalancerTlsCertificateSummary.Builder>... tlsCertificateSummaries)` An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates.
`LoadBalancer.Builder`	`tlsCertificateSummaries(LoadBalancerTlsCertificateSummary... tlsCertificateSummaries)` An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates.
`LoadBalancer.Builder`	`tlsPolicyName(String tlsPolicyName)` The name of the TLS security policy for the load balancer.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - name
```
LoadBalancer.Builder name(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.
  - arn
```
LoadBalancer.Builder arn(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.
  - supportCode
```
LoadBalancer.Builder supportCode(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.
  - createdAt
```
LoadBalancer.Builder createdAt(Instant 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
```
LoadBalancer.Builder location(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - location
```
default LoadBalancer.Builder location(Consumer<ResourceLocation.Builder> location)
```
    The AWS Region where your load balancer was created (e.g., us-east-2a). Lightsail automatically creates your load balancer across Availability Zones.
    This is a convenience method that creates an instance of the ResourceLocation.Builder avoiding the need to create one manually via ResourceLocation.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to location(ResourceLocation).
    
    Parameters:
    
    location - a consumer that will call methods on ResourceLocation.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    location(ResourceLocation)
  - resourceType
```
LoadBalancer.Builder resourceType(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, ResourceType
  - resourceType
```
LoadBalancer.Builder resourceType(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, ResourceType
  - tags
```
LoadBalancer.Builder tags(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.
    
    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
```
LoadBalancer.Builder tags(Tag... 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
```
LoadBalancer.Builder tags(Consumer<Tag.Builder>... 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 the Tag.Builder avoiding the need to create one manually via Tag.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).
    
    Parameters:
    
    tags - a consumer that will call methods on Tag.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #tags(java.util.Collection)
  - dnsName
```
LoadBalancer.Builder dnsName(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.
  - state
```
LoadBalancer.Builder state(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, LoadBalancerState
  - state
```
LoadBalancer.Builder state(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, LoadBalancerState
  - protocol
```
LoadBalancer.Builder protocol(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.
    
    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 just HTTP.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LoadBalancerProtocol, LoadBalancerProtocol
  - protocol
```
LoadBalancer.Builder protocol(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.
    
    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 just HTTP.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LoadBalancerProtocol, LoadBalancerProtocol
  - publicPorts
```
LoadBalancer.Builder publicPorts(Collection<Integer> 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
```
LoadBalancer.Builder publicPorts(Integer... 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
```
LoadBalancer.Builder healthCheckPath(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.
  - instancePort
```
LoadBalancer.Builder instancePort(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.
    
    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
```
LoadBalancer.Builder instanceHealthSummary(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.
  - instanceHealthSummary
```
LoadBalancer.Builder instanceHealthSummary(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.
  - 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 the InstanceHealthSummary.Builder avoiding the need to create one manually via InstanceHealthSummary.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #instanceHealthSummary(List).
    
    Parameters:
    
    instanceHealthSummary - a consumer that will call methods on InstanceHealthSummary.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #instanceHealthSummary(java.util.Collection)
  - 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, if true, 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, if true, 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 true, the certificate is attached to the load balancer.
    This is a convenience method that creates an instance of the LoadBalancerTlsCertificateSummary.Builder avoiding the need to create one manually via LoadBalancerTlsCertificateSummary.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tlsCertificateSummaries(List).
    
    Parameters:
    
    tlsCertificateSummaries - a consumer that will call methods on LoadBalancerTlsCertificateSummary.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #tlsCertificateSummaries(java.util.Collection)
  - configurationOptionsWithStrings
```
LoadBalancer.Builder configurationOptionsWithStrings(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.
  - 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
```
LoadBalancer.Builder ipAddressType(String ipAddressType)
```
    The IP address type of the load balancer.
    
    The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
    
    Parameters:
    
    ipAddressType - The IP address type of the load balancer.
    
    The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IpAddressType, IpAddressType
  - ipAddressType
```
LoadBalancer.Builder ipAddressType(IpAddressType ipAddressType)
```
    The IP address type of the load balancer.
    
    The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
    
    Parameters:
    
    ipAddressType - The IP address type of the load balancer.
    
    The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IpAddressType, IpAddressType
  - httpsRedirectionEnabled
```
LoadBalancer.Builder httpsRedirectionEnabled(Boolean 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
```
LoadBalancer.Builder tlsPolicyName(String 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.

Interface LoadBalancer.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

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

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

Method Detail

name

arn

supportCode

createdAt

location

location

resourceType

resourceType

tags

tags

tags

dnsName

state

state

protocol

protocol

publicPorts

publicPorts

healthCheckPath

instancePort

instanceHealthSummary

instanceHealthSummary

instanceHealthSummary

tlsCertificateSummaries

tlsCertificateSummaries

tlsCertificateSummaries

configurationOptionsWithStrings

configurationOptions

ipAddressType

ipAddressType

httpsRedirectionEnabled

tlsPolicyName