Skip to content

Set Subnets

elbv2_set_subnets R Documentation

Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer, Network Load Balancer or Gateway Load Balancer

Description

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.

Usage

elbv2_set_subnets(LoadBalancerArn, Subnets, SubnetMappings,
  IpAddressType, EnablePrefixForIpv6SourceNat)

Arguments

LoadBalancerArn

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

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

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

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

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.

Value

A list with the following syntax: 

list(
  AvailabilityZones = list(
    list(
      ZoneName = "string",
      SubnetId = "string",
      OutpostId = "string",
      LoadBalancerAddresses = list(
        list(
          IpAddress = "string",
          AllocationId = "string",
          PrivateIPv4Address = "string",
          IPv6Address = "string"
        )
      ),
      SourceNatIpv6Prefixes = list(
        "string"
      )
    )
  ),
  IpAddressType = "ipv4"|"dualstack"|"dualstack-without-public-ipv4",
  EnablePrefixForIpv6SourceNat = "on"|"off"
)

Request syntax

svc$set_subnets(
  LoadBalancerArn = "string",
  Subnets = list(
    "string"
  ),
  SubnetMappings = list(
    list(
      SubnetId = "string",
      AllocationId = "string",
      PrivateIPv4Address = "string",
      IPv6Address = "string",
      SourceNatIpv6Prefix = "string"
    )
  ),
  IpAddressType = "ipv4"|"dualstack"|"dualstack-without-public-ipv4",
  EnablePrefixForIpv6SourceNat = "on"|"off"
)

Examples

## Not run: 
# This example enables the Availability Zones for the specified subnets
# for the specified load balancer.
svc$set_subnets(
  LoadBalancerArn = "arn:aws:elasticloadbalancing:us-west-2:123456789012:lo...",
  Subnets = list(
    "subnet-8360a9e7",
    "subnet-b7d581c0"
  )
)

## End(Not run)