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

Interface CreateLoadBalancerRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateLoadBalancerRequest.Builder,CreateLoadBalancerRequest>, ElasticLoadBalancingV2Request.Builder, SdkBuilder<CreateLoadBalancerRequest.Builder,CreateLoadBalancerRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateLoadBalancerRequest
public static interface CreateLoadBalancerRequest.Builder extends ElasticLoadBalancingV2Request.Builder, SdkPojo, CopyableBuilder<CreateLoadBalancerRequest.Builder,CreateLoadBalancerRequest>

  • Method Details

    • 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] You can specify subnets from one or more Availability Zones.

      [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] You can specify subnets from one or more Availability Zones.

      [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] You can specify subnets from one or more Availability Zones.

      [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] You can specify subnets from one or more Availability Zones.

      [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 cannot 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 cannot 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 cannot 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 cannot 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 cannot 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 cannot 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 cannot 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 cannot 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 cannot 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 cannot 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<SubnetMapping>).

      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:

    • 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 cannot 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 cannot 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

      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 cannot 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 cannot 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

      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.

    • tags

      CreateLoadBalancerRequest.Builder tags(Consumer<Tag.Builder>... tags)

      The tags to assign to the load balancer.

      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<Tag>).

      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:

    • type

      CreateLoadBalancerRequest.Builder type(String type)

      The type of load balancer. The default is application.

      Parameters:
      type - The type of load balancer. The default is application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      CreateLoadBalancerRequest.Builder type(LoadBalancerTypeEnum type)

      The type of load balancer. The default is application.

      Parameters:
      type - The type of load balancer. The default is application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ipAddressType

      CreateLoadBalancerRequest.Builder ipAddressType(String ipAddressType)

      The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).

      Parameters:
      ipAddressType - The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ipAddressType

      CreateLoadBalancerRequest.Builder ipAddressType(IpAddressType ipAddressType)

      The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).

      Parameters:
      ipAddressType - The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • overrideConfiguration

      CreateLoadBalancerRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.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 interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.