ElasticLoadBalancingv2 / Client / set_subnets

set_subnets#

ElasticLoadBalancingv2.Client.set_subnets(**kwargs)#

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.

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

Request Syntax

response = client.set_subnets(
    LoadBalancerArn='string',
    Subnets=[
        'string',
    ],
    SubnetMappings=[
        {
            'SubnetId': 'string',
            'AllocationId': 'string',
            'PrivateIPv4Address': 'string',
            'IPv6Address': 'string',
            'SourceNatIpv6Prefix': 'string'
        },
    ],
    IpAddressType='ipv4'|'dualstack'|'dualstack-without-public-ipv4',
    EnablePrefixForIpv6SourceNat='on'|'off'
)

Parameters:

LoadBalancerArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the load balancer.
Subnets (list) –
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 and Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
- (string) –
SubnetMappings (list) –
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.
- (dict) –
  
  Information about a subnet mapping.
  - SubnetId (string) –
    
    The ID of the subnet.
  - AllocationId (string) –
    
    [Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer.
  - PrivateIPv4Address (string) –
    
    [Network Load Balancers] The private IPv4 address for an internal load balancer.
  - IPv6Address (string) –
    
    [Network Load Balancers] The IPv6 address.
  - SourceNatIpv6Prefix (string) –
    
    [Network Load Balancers with UDP listeners] The IPv6 prefix to use for source NAT. Specify an IPv6 prefix (/80 netmask) from the subnet CIDR block or auto_assigned to use an IPv6 prefix selected at random from the subnet CIDR block.
IpAddressType (string) –
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).
EnablePrefixForIpv6SourceNat (string) – [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.

Return type:

dict

Returns:

Response Syntax

{
    'AvailabilityZones': [
        {
            'ZoneName': 'string',
            'SubnetId': 'string',
            'OutpostId': 'string',
            'LoadBalancerAddresses': [
                {
                    'IpAddress': 'string',
                    'AllocationId': 'string',
                    'PrivateIPv4Address': 'string',
                    'IPv6Address': 'string'
                },
            ],
            'SourceNatIpv6Prefixes': [
                'string',
            ]
        },
    ],
    'IpAddressType': 'ipv4'|'dualstack'|'dualstack-without-public-ipv4',
    'EnablePrefixForIpv6SourceNat': 'on'|'off'
}

Response Structure

(dict) –
- AvailabilityZones (list) –
  
  Information about the subnets.
  - (dict) –
    
    Information about an Availability Zone.
    - ZoneName (string) –
      
      The name of the Availability Zone.
    - SubnetId (string) –
      
      The ID of the subnet. You can specify one subnet per Availability Zone.
    - OutpostId (string) –
      
      [Application Load Balancers on Outposts] The ID of the Outpost.
    - LoadBalancerAddresses (list) –
      
      [Network Load Balancers] If you need static IP addresses for your load balancer, you can specify one Elastic IP address per Availability Zone when you create an internal-facing load balancer. For internal load balancers, you can specify a private IP address from the IPv4 range of the subnet.
      - (dict) –
        
        Information about a static IP address for a load balancer.
        
        IpAddress (string) –
        
        The static IP address.
        
        AllocationId (string) –
        
        [Network Load Balancers] The allocation ID of the Elastic IP address for an internal-facing load balancer.
        
        PrivateIPv4Address (string) –
        
        [Network Load Balancers] The private IPv4 address for an internal load balancer.
        
        IPv6Address (string) –
        
        [Network Load Balancers] The IPv6 address.
    - SourceNatIpv6Prefixes (list) –
      
      [Network Load Balancers with UDP listeners] The IPv6 prefixes to use for source NAT. For each subnet, specify an IPv6 prefix (/80 netmask) from the subnet CIDR block or auto_assigned to use an IPv6 prefix selected at random from the subnet CIDR block.
      - (string) –
- IpAddressType (string) –
  
  The IP address type.
- EnablePrefixForIpv6SourceNat (string) –
  
  [Network Load Balancers] Indicates whether to use an IPv6 prefix from each subnet for source NAT.

Exceptions

ElasticLoadBalancingv2.Client.exceptions.LoadBalancerNotFoundException
ElasticLoadBalancingv2.Client.exceptions.InvalidConfigurationRequestException
ElasticLoadBalancingv2.Client.exceptions.SubnetNotFoundException
ElasticLoadBalancingv2.Client.exceptions.InvalidSubnetException
ElasticLoadBalancingv2.Client.exceptions.AllocationIdNotFoundException
ElasticLoadBalancingv2.Client.exceptions.AvailabilityZoneNotSupportedException
ElasticLoadBalancingv2.Client.exceptions.CapacityReservationPendingException

Examples

This example enables the Availability Zones for the specified subnets for the specified load balancer.

response = client.set_subnets(
    LoadBalancerArn='arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
    Subnets=[
        'subnet-8360a9e7',
        'subnet-b7d581c0',
    ],
)

print(response)

Expected Output:

{
    'AvailabilityZones': [
        {
            'SubnetId': 'subnet-8360a9e7',
            'ZoneName': 'us-west-2a',
        },
        {
            'SubnetId': 'subnet-b7d581c0',
            'ZoneName': 'us-west-2b',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}