Interface CreateLoadBalancerRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateLoadBalancerRequest.Builder,
,CreateLoadBalancerRequest> ElasticLoadBalancingV2Request.Builder
,SdkBuilder<CreateLoadBalancerRequest.Builder,
,CreateLoadBalancerRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateLoadBalancerRequest
-
Method Summary
Modifier and TypeMethodDescriptioncustomerOwnedIpv4Pool
(String customerOwnedIpv4Pool) [Application Load Balancers on Outposts] The ID of the customer-owned address pool (CoIP pool).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.ipAddressType
(String ipAddressType) The IP address type.ipAddressType
(IpAddressType ipAddressType) The IP address type.ipamPools
(Consumer<IpamPools.Builder> ipamPools) [Application Load Balancers] The IPAM pools to use with the load balancer.[Application Load Balancers] The IPAM pools to use with the load balancer.The name of the load balancer.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.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) [Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.securityGroups
(Collection<String> securityGroups) [Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.subnetMappings
(Collection<SubnetMapping> subnetMappings) The IDs of the subnets.subnetMappings
(Consumer<SubnetMapping.Builder>... subnetMappings) The IDs of the subnets.subnetMappings
(SubnetMapping... subnetMappings) The IDs of the subnets.The IDs of the subnets.subnets
(Collection<String> subnets) The IDs of the subnets.tags
(Collection<Tag> tags) The tags to assign to the load balancer.tags
(Consumer<Tag.Builder>... tags) The tags to assign to the load balancer.The tags to assign to the load balancer.The type of load balancer.type
(LoadBalancerTypeEnum type) The type of load balancer.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.elasticloadbalancingv2.model.ElasticLoadBalancingV2Request.Builder
build
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
-
name
The name of the load balancer.
This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-".
- Parameters:
name
- The name of the load balancer.This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-".
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subnets
The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets.
[Application Load Balancers] You must specify subnets from at least two Availability Zones.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers and Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
- Parameters:
subnets
- The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets.[Application Load Balancers] You must specify subnets from at least two Availability Zones.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers and Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subnets
The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets.
[Application Load Balancers] You must specify subnets from at least two Availability Zones.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers and Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
- Parameters:
subnets
- The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets.[Application Load Balancers] You must specify subnets from at least two Availability Zones.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers and Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subnetMappings
The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both.
[Application Load Balancers] You must specify subnets from at least two Availability Zones. You can't specify Elastic IP addresses for your subnets.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.
[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You can't specify Elastic IP addresses for your subnets.
- Parameters:
subnetMappings
- The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both.[Application Load Balancers] You must specify subnets from at least two Availability Zones. You can't specify Elastic IP addresses for your subnets.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.
[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You can't specify Elastic IP addresses for your subnets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subnetMappings
The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both.
[Application Load Balancers] You must specify subnets from at least two Availability Zones. You can't specify Elastic IP addresses for your subnets.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.
[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You can't specify Elastic IP addresses for your subnets.
- Parameters:
subnetMappings
- The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both.[Application Load Balancers] You must specify subnets from at least two Availability Zones. You can't specify Elastic IP addresses for your subnets.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.
[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You can't specify Elastic IP addresses for your subnets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subnetMappings
The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both.
[Application Load Balancers] You must specify subnets from at least two Availability Zones. You can't specify Elastic IP addresses for your subnets.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.
[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You can't specify Elastic IP addresses for your subnets.
This is a convenience method that creates an instance of theSubnetMapping.Builder
avoiding the need to create one manually viaSubnetMapping.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosubnetMappings(List<SubnetMapping>)
.- Parameters:
subnetMappings
- a consumer that will call methods onSubnetMapping.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
securityGroups
[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.
- Parameters:
securityGroups
- [Application Load Balancers and Network Load Balancers] 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
[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.
- Parameters:
securityGroups
- [Application Load Balancers and Network Load Balancers] 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.
-
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.
The default is an Internet-facing load balancer.
You can't specify a scheme for a Gateway 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.
The default is an Internet-facing load balancer.
You can't specify a scheme for a Gateway 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.
The default is an Internet-facing load balancer.
You can't specify a scheme for a Gateway 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.
The default is an Internet-facing load balancer.
You can't specify a scheme for a Gateway Load Balancer.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tags
The tags to assign to the load balancer.
- Parameters:
tags
- The tags to assign to the load balancer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The tags to assign to the load balancer.
- Parameters:
tags
- The tags to assign to the load balancer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The tags to assign to the load balancer.
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:
-
type
The type of load balancer. The default is
application
.- Parameters:
type
- The type of load balancer. The default isapplication
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
type
The type of load balancer. The default is
application
.- Parameters:
type
- The type of load balancer. The default isapplication
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
ipAddressType
The IP address type. Internal load balancers must use
ipv4
.[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 IP address type. Internal load balancers must useipv4
.[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 IP address type. Internal load balancers must use
ipv4
.[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 IP address type. Internal load balancers must useipv4
.[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 (CoIP pool).
- Parameters:
customerOwnedIpv4Pool
- [Application Load Balancers on Outposts] The ID of the customer-owned address pool (CoIP pool).- 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
CreateLoadBalancerRequest.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 pools to use with the load balancer.
- Parameters:
ipamPools
- [Application Load Balancers] The IPAM pools to use with the load balancer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ipamPools
[Application Load Balancers] The IPAM pools to use with the load balancer.
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:
-
overrideConfiguration
CreateLoadBalancerRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateLoadBalancerRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-