Package software.amazon.awssdk.services.elasticloadbalancingv2.model

Interface CreateLoadBalancerRequest.Builder

    • Method Detail

      • name

        CreateLoadBalancerRequest.Builder name​(String 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

        CreateLoadBalancerRequest.Builder subnets​(Collection<String> 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

        CreateLoadBalancerRequest.Builder subnets​(String... 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

        CreateLoadBalancerRequest.Builder subnetMappings​(Collection<SubnetMapping> 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

        CreateLoadBalancerRequest.Builder subnetMappings​(SubnetMapping... 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

        CreateLoadBalancerRequest.Builder subnetMappings​(Consumer<SubnetMapping.Builder>... 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 the SubnetMapping.Builder avoiding the need to create one manually via SubnetMapping.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #subnetMappings(List).

        Parameters:
        subnetMappings - a consumer that will call methods on SubnetMapping.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #subnetMappings(java.util.Collection)

      • securityGroups

        CreateLoadBalancerRequest.Builder securityGroups​(Collection<String> 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

        CreateLoadBalancerRequest.Builder securityGroups​(String... 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

        CreateLoadBalancerRequest.Builder scheme​(String 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:
        LoadBalancerSchemeEnum, LoadBalancerSchemeEnum

      • scheme

        CreateLoadBalancerRequest.Builder scheme​(LoadBalancerSchemeEnum 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:
        LoadBalancerSchemeEnum, LoadBalancerSchemeEnum

      • tags

        CreateLoadBalancerRequest.Builder tags​(Collection<Tag> 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

        CreateLoadBalancerRequest.Builder tags​(Tag... 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.

      • ipAddressType

        CreateLoadBalancerRequest.Builder ipAddressType​(String 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), and dualstack-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) and dualstack (IPv4 and IPv6 addresses).

        Parameters:
        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), and dualstack-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) and dualstack (IPv4 and IPv6 addresses).

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        IpAddressType, IpAddressType

      • ipAddressType

        CreateLoadBalancerRequest.Builder ipAddressType​(IpAddressType 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), and dualstack-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) and dualstack (IPv4 and IPv6 addresses).

        Parameters:
        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), and dualstack-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) and dualstack (IPv4 and IPv6 addresses).

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        IpAddressType, IpAddressType

      • customerOwnedIpv4Pool

        CreateLoadBalancerRequest.Builder customerOwnedIpv4Pool​(String 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

        CreateLoadBalancerRequest.Builder enablePrefixForIpv6SourceNat​(String 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 is off.

        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 be dualstack. The default value is off.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EnablePrefixForIpv6SourceNatEnum, EnablePrefixForIpv6SourceNatEnum

      • 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 is off.

        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 be dualstack. The default value is off.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EnablePrefixForIpv6SourceNatEnum, EnablePrefixForIpv6SourceNatEnum