setSubnets method

Future<SetSubnetsOutput> setSubnets({ required String loadBalancerArn, IpAddressType? ipAddressType, List<SubnetMapping>? subnetMappings, List<String>? subnets, })

Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer or Network Load Balancer. The specified subnets replace the previously enabled subnets.

When you specify subnets for a Network Load Balancer, you must include all subnets that were enabled previously, with their existing configurations, plus any additional subnets.

May throw LoadBalancerNotFoundException. May throw InvalidConfigurationRequestException. May throw SubnetNotFoundException. May throw InvalidSubnetException. May throw AllocationIdNotFoundException. May throw AvailabilityZoneNotSupportedException.

Parameter loadBalancerArn : The Amazon Resource Name (ARN) of the load balancer.

Parameter ipAddressType : Network Load Balancers 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). You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener. Internal load balancers must use ipv4.

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.

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.

Implementation

Future<SetSubnetsOutput> setSubnets({
  required String loadBalancerArn,
  IpAddressType? ipAddressType,
  List<SubnetMapping>? subnetMappings,
  List<String>? subnets,
}) async {
  ArgumentError.checkNotNull(loadBalancerArn, 'loadBalancerArn');
  final $request = <String, dynamic>{};
  $request['LoadBalancerArn'] = loadBalancerArn;
  ipAddressType?.also((arg) => $request['IpAddressType'] = arg.toValue());
  subnetMappings?.also((arg) => $request['SubnetMappings'] = arg);
  subnets?.also((arg) => $request['Subnets'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'SetSubnets',
    version: '2015-12-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['SetSubnetsInput'],
    shapes: shapes,
    resultWrapper: 'SetSubnetsResult',
  );
  return SetSubnetsOutput.fromXml($result);
}