SetSubnets - Elastic Load Balancing
Request ParametersResponse ElementsErrorsExamplesSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

SetSubnets

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

Request Parameters

For information about the parameters that are common to all actions, see Common 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.

Type: String

Valid Values: on | off

Required: No

IpAddressType

The IP address type.

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

Type: String

Valid Values: ipv4 | dualstack | dualstack-without-public-ipv4

Required: No

LoadBalancerArn

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

Type: String

Required: Yes

SubnetMappings.member.N

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

Type: Array of SubnetMapping objects

Required: No

Subnets.member.N

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. You must include all subnets that were enabled previously, with their existing configurations, plus any additional subnets.

Type: Array of strings

Required: No

Response Elements

The following elements are returned by the service.

AvailabilityZones.member.N

Information about the subnets.

Type: Array of AvailabilityZone objects

EnablePrefixForIpv6SourceNat

[Network Load Balancers] Indicates whether to use an IPv6 prefix from each subnet for source NAT.

Type: String

Valid Values: on | off

IpAddressType

The IP address type.

Type: String

Valid Values: ipv4 | dualstack | dualstack-without-public-ipv4

Errors

For information about the errors that are common to all actions, see Common Errors.

AllocationIdNotFound

The specified allocation ID does not exist.

HTTP Status Code: 400

AvailabilityZoneNotSupported

The specified Availability Zone is not supported.

HTTP Status Code: 400

CapacityReservationPending

There is a pending capacity reservation.

HTTP Status Code: 400

InvalidConfigurationRequest

The requested configuration is not valid.

HTTP Status Code: 400

InvalidSubnet

The specified subnet is out of available addresses.

HTTP Status Code: 400

LoadBalancerNotFound

The specified load balancer does not exist.

HTTP Status Code: 400

SubnetNotFound

The specified subnet does not exist.

HTTP Status Code: 400

Examples

Enable Availability Zones for a load balancer

This example enables the Availability Zone for the specified subnet for the specified load balancer.

Sample Request

https://elasticloadbalancing.amazonaws.com/?Action=SetSubnets
&LoadBalancerArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188
&Subnets.member.1=subnet-8360a9e7
&Subnets.member.2=subnet-b7d581c0
&Version=2015-12-01
&AUTHPARAMS

Sample Response

<SetSubnetsResponse xmlns="http://elasticloadbalancing.amazonaws.com/doc/2015-12-01/">
  <SetSubnetsResult> 
    <AvailabilityZones> 
      <member> 
        <SubnetId>subnet-8360a9e7</SubnetId> 
        <ZoneName>us-west-2a</ZoneName> 
      </member> 
      <member> 
        <SubnetId>subnet-b7d581c0</SubnetId> 
        <ZoneName>us-west-2b</ZoneName> 
      </member> 
    </AvailabilityZones> 
  </SetSubnetsResult> 
  <ResponseMetadata> 
    <RequestId>c1a80803-f3ab-11e5-b673-8d4a8a9e6f48</RequestId> 
  </ResponseMetadata> 
</SetSubnetsResponse>

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: