createLoadBalancer method

Future<CreateLoadBalancerOutput> createLoadBalancer({ required String name, String? customerOwnedIpv4Pool, IpAddressType? ipAddressType, LoadBalancerSchemeEnum? scheme, List<String>? securityGroups, List<SubnetMapping>? subnetMappings, List<String>? subnets, List<Tag>? tags, LoadBalancerTypeEnum? type, })

Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

For more information, see the following:

• Application Load Balancers
• Network Load Balancers
• Gateway Load Balancers

This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple load balancers with the same settings, each call succeeds.

May throw DuplicateLoadBalancerNameException. May throw TooManyLoadBalancersException. May throw InvalidConfigurationRequestException. May throw SubnetNotFoundException. May throw InvalidSubnetException. May throw InvalidSecurityGroupException. May throw InvalidSchemeException. May throw TooManyTagsException. May throw DuplicateTagKeysException. May throw ResourceInUseException. May throw AllocationIdNotFoundException. May throw AvailabilityZoneNotSupportedException. May throw OperationNotPermittedException.

Parameter 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-".

Parameter customerOwnedIpv4Pool : Application Load Balancers on Outposts The ID of the customer-owned address pool (CoIP pool).

Parameter 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). Internal load balancers must use ipv4.

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

Parameter securityGroups : Application Load Balancers The IDs of the security groups for the load balancer.

Parameter subnetMappings : The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

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.

Parameter subnets : The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

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.

Parameter tags : The tags to assign to the load balancer.

Parameter type : The type of load balancer. The default is application.

Implementation

Future<CreateLoadBalancerOutput> createLoadBalancer({
  required String name,
  String? customerOwnedIpv4Pool,
  IpAddressType? ipAddressType,
  LoadBalancerSchemeEnum? scheme,
  List<String>? securityGroups,
  List<SubnetMapping>? subnetMappings,
  List<String>? subnets,
  List<Tag>? tags,
  LoadBalancerTypeEnum? type,
}) async {
  ArgumentError.checkNotNull(name, 'name');
  _s.validateStringLength(
    'customerOwnedIpv4Pool',
    customerOwnedIpv4Pool,
    0,
    256,
  );
  final $request = <String, dynamic>{};
  $request['Name'] = name;
  customerOwnedIpv4Pool
      ?.also((arg) => $request['CustomerOwnedIpv4Pool'] = arg);
  ipAddressType?.also((arg) => $request['IpAddressType'] = arg.toValue());
  scheme?.also((arg) => $request['Scheme'] = arg.toValue());
  securityGroups?.also((arg) => $request['SecurityGroups'] = arg);
  subnetMappings?.also((arg) => $request['SubnetMappings'] = arg);
  subnets?.also((arg) => $request['Subnets'] = arg);
  tags?.also((arg) => $request['Tags'] = arg);
  type?.also((arg) => $request['Type'] = arg.toValue());
  final $result = await _protocol.send(
    $request,
    action: 'CreateLoadBalancer',
    version: '2015-12-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['CreateLoadBalancerInput'],
    shapes: shapes,
    resultWrapper: 'CreateLoadBalancerResult',
  );
  return CreateLoadBalancerOutput.fromXml($result);
}