Interface LoadBalancer.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<LoadBalancer.Builder,
,LoadBalancer> SdkBuilder<LoadBalancer.Builder,
,LoadBalancer> SdkPojo
- Enclosing class:
LoadBalancer
-
Method Summary
Modifier and TypeMethodDescriptionavailabilityZones
(Collection<AvailabilityZone> availabilityZones) The subnets for the load balancer.availabilityZones
(Consumer<AvailabilityZone.Builder>... availabilityZones) The subnets for the load balancer.availabilityZones
(AvailabilityZone... availabilityZones) The subnets for the load balancer.canonicalHostedZoneId
(String canonicalHostedZoneId) The ID of the Amazon Route 53 hosted zone associated with the load balancer.createdTime
(Instant createdTime) The date and time the load balancer was created.customerOwnedIpv4Pool
(String customerOwnedIpv4Pool) [Application Load Balancers on Outposts] The ID of the customer-owned address pool.The public DNS name of the load balancer.enablePrefixForIpv6SourceNat
(String enablePrefixForIpv6SourceNat) [Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT.enablePrefixForIpv6SourceNat
(EnablePrefixForIpv6SourceNatEnum enablePrefixForIpv6SourceNat) [Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT.enforceSecurityGroupInboundRulesOnPrivateLinkTraffic
(String enforceSecurityGroupInboundRulesOnPrivateLinkTraffic) Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through Amazon Web Services PrivateLink.ipAddressType
(String ipAddressType) The type of IP addresses used for public or private connections by the subnets attached to your load balancer.ipAddressType
(IpAddressType ipAddressType) The type of IP addresses used for public or private connections by the subnets attached to your load balancer.default LoadBalancer.Builder
ipamPools
(Consumer<IpamPools.Builder> ipamPools) [Application Load Balancers] The IPAM pool in use by the load balancer, if configured.[Application Load Balancers] The IPAM pool in use by the load balancer, if configured.loadBalancerArn
(String loadBalancerArn) The Amazon Resource Name (ARN) of the load balancer.loadBalancerName
(String loadBalancerName) The name of the load balancer.The nodes of an Internet-facing load balancer have public IP addresses.scheme
(LoadBalancerSchemeEnum scheme) The nodes of an Internet-facing load balancer have public IP addresses.securityGroups
(String... securityGroups) The IDs of the security groups for the load balancer.securityGroups
(Collection<String> securityGroups) The IDs of the security groups for the load balancer.default LoadBalancer.Builder
state
(Consumer<LoadBalancerState.Builder> state) The state of the load balancer.state
(LoadBalancerState state) The state of the load balancer.The type of load balancer.type
(LoadBalancerTypeEnum type) The type of load balancer.The ID of the VPC 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, sdkFieldNameToField, sdkFields
-
Method Details
-
loadBalancerArn
The Amazon Resource Name (ARN) of the load balancer.
- Parameters:
loadBalancerArn
- The Amazon Resource Name (ARN) of the load balancer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dnsName
The public DNS name of the load balancer.
- Parameters:
dnsName
- The public DNS name of the load balancer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
canonicalHostedZoneId
The ID of the Amazon Route 53 hosted zone associated with the load balancer.
- Parameters:
canonicalHostedZoneId
- The ID of the Amazon Route 53 hosted zone associated with the load balancer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdTime
The date and time the load balancer was created.
- Parameters:
createdTime
- The date and time the load balancer was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
loadBalancerName
The name of the load balancer.
- Parameters:
loadBalancerName
- The name of the load balancer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scheme
The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.
The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.
- Parameters:
scheme
- The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
scheme
The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.
The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.
- Parameters:
scheme
- The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
vpcId
The ID of the VPC for the load balancer.
- Parameters:
vpcId
- The ID of the VPC for the load balancer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
state
The state of the load balancer.
- Parameters:
state
- The state of the load balancer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
state
The state of the load balancer.
This is a convenience method that creates an instance of theLoadBalancerState.Builder
avoiding the need to create one manually viaLoadBalancerState.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostate(LoadBalancerState)
.- Parameters:
state
- a consumer that will call methods onLoadBalancerState.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
type
The type of load balancer.
- Parameters:
type
- The type of load balancer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
type
The type of load balancer.
- Parameters:
type
- The type of load balancer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
availabilityZones
The subnets for the load balancer.
- Parameters:
availabilityZones
- The subnets for the load balancer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
availabilityZones
The subnets for the load balancer.
- Parameters:
availabilityZones
- The subnets for the load balancer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
availabilityZones
The subnets for the load balancer.
This is a convenience method that creates an instance of theAvailabilityZone.Builder
avoiding the need to create one manually viaAvailabilityZone.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toavailabilityZones(List<AvailabilityZone>)
.- Parameters:
availabilityZones
- a consumer that will call methods onAvailabilityZone.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
securityGroups
The IDs of the security groups for the load balancer.
- Parameters:
securityGroups
- The IDs of the security groups for the load balancer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
securityGroups
The IDs of the security groups for the load balancer.
- Parameters:
securityGroups
- The IDs of the security groups for the load balancer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ipAddressType
The type of IP addresses used for public or private connections by the subnets attached to your load balancer.
[Application Load Balancers] The possible values are
ipv4
(IPv4 addresses),dualstack
(IPv4 and IPv6 addresses), anddualstack-without-public-ipv4
(public IPv6 addresses and private IPv4 and IPv6 addresses).[Network Load Balancers and Gateway Load Balancers] The possible values are
ipv4
(IPv4 addresses) anddualstack
(IPv4 and IPv6 addresses).- Parameters:
ipAddressType
- The type of IP addresses used for public or private connections by the subnets attached to your load balancer.[Application Load Balancers] The possible values are
ipv4
(IPv4 addresses),dualstack
(IPv4 and IPv6 addresses), anddualstack-without-public-ipv4
(public IPv6 addresses and private IPv4 and IPv6 addresses).[Network Load Balancers and Gateway Load Balancers] The possible values are
ipv4
(IPv4 addresses) anddualstack
(IPv4 and IPv6 addresses).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
ipAddressType
The type of IP addresses used for public or private connections by the subnets attached to your load balancer.
[Application Load Balancers] The possible values are
ipv4
(IPv4 addresses),dualstack
(IPv4 and IPv6 addresses), anddualstack-without-public-ipv4
(public IPv6 addresses and private IPv4 and IPv6 addresses).[Network Load Balancers and Gateway Load Balancers] The possible values are
ipv4
(IPv4 addresses) anddualstack
(IPv4 and IPv6 addresses).- Parameters:
ipAddressType
- The type of IP addresses used for public or private connections by the subnets attached to your load balancer.[Application Load Balancers] The possible values are
ipv4
(IPv4 addresses),dualstack
(IPv4 and IPv6 addresses), anddualstack-without-public-ipv4
(public IPv6 addresses and private IPv4 and IPv6 addresses).[Network Load Balancers and Gateway Load Balancers] The possible values are
ipv4
(IPv4 addresses) anddualstack
(IPv4 and IPv6 addresses).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
customerOwnedIpv4Pool
[Application Load Balancers on Outposts] The ID of the customer-owned address pool.
- Parameters:
customerOwnedIpv4Pool
- [Application Load Balancers on Outposts] The ID of the customer-owned address pool.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
enforceSecurityGroupInboundRulesOnPrivateLinkTraffic
LoadBalancer.Builder enforceSecurityGroupInboundRulesOnPrivateLinkTraffic(String enforceSecurityGroupInboundRulesOnPrivateLinkTraffic) Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through Amazon Web Services PrivateLink.
- Parameters:
enforceSecurityGroupInboundRulesOnPrivateLinkTraffic
- Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through Amazon Web Services PrivateLink.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
enablePrefixForIpv6SourceNat
[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT. The IP address type must be
dualstack
. The default value isoff
.- Parameters:
enablePrefixForIpv6SourceNat
- [Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT. The IP address type must bedualstack
. The default value isoff
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
enablePrefixForIpv6SourceNat
LoadBalancer.Builder enablePrefixForIpv6SourceNat(EnablePrefixForIpv6SourceNatEnum enablePrefixForIpv6SourceNat) [Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT. The IP address type must be
dualstack
. The default value isoff
.- Parameters:
enablePrefixForIpv6SourceNat
- [Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT. The IP address type must bedualstack
. The default value isoff
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
ipamPools
[Application Load Balancers] The IPAM pool in use by the load balancer, if configured.
- Parameters:
ipamPools
- [Application Load Balancers] The IPAM pool in use by the load balancer, if configured.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ipamPools
[Application Load Balancers] The IPAM pool in use by the load balancer, if configured.
This is a convenience method that creates an instance of theIpamPools.Builder
avoiding the need to create one manually viaIpamPools.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toipamPools(IpamPools)
.- Parameters:
ipamPools
- a consumer that will call methods onIpamPools.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-