interface SubnetMapping

Language	Type name
.NET	Amazon.CDK.AWS.ElasticLoadBalancingV2.SubnetMapping
Go	github.com/aws/aws-cdk-go/awscdk/v2/awselasticloadbalancingv2#SubnetMapping
Java	software.amazon.awscdk.services.elasticloadbalancingv2.SubnetMapping
Python	aws_cdk.aws_elasticloadbalancingv2.SubnetMapping
TypeScript (source)	aws-cdk-lib » aws_elasticloadbalancingv2 » SubnetMapping

Specifies a subnet for a load balancer.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_elasticloadbalancingv2 as elbv2 } from 'aws-cdk-lib';

declare const sourceNatIpv6Prefix: elbv2.SourceNatIpv6Prefix;
declare const subnet: ec2.Subnet;
const subnetMapping: elbv2.SubnetMapping = {
  subnet: subnet,

  // the properties below are optional
  allocationId: 'allocationId',
  ipv6Address: 'ipv6Address',
  privateIpv4Address: 'privateIpv4Address',
  sourceNatIpv6Prefix: sourceNatIpv6Prefix,
};

Properties

Name	Type	Description
subnet	ISubnet	The subnet.
allocationId?	string	The allocation ID of the Elastic IP address for an internet-facing load balancer.
ipv6Address?	string	The IPv6 address.
privateIpv4Address?	string	The private IPv4 address for an internal load balancer.
sourceNatIpv6Prefix?	SourceNatIpv6Prefix	The IPv6 prefix to use for source NAT for a dual-stack network load balancer with UDP listeners.

---

subnet

Type: ISubnet

The subnet.

---

allocationId?

Type: string (optional, default: undefined - AWS default is to allocate a new IP address for internet-facing load balancers)

The allocation ID of the Elastic IP address for an internet-facing load balancer.

---

ipv6Address?

Type: string (optional, default: undefined - AWS default is to allocate an IPv6 address from the subnet's pool)

The IPv6 address.

---

privateIpv4Address?

Type: string (optional, default: undefined - AWS default is to allocate a private IPv4 address from the subnet's pool)

The private IPv4 address for an internal load balancer.

---

sourceNatIpv6Prefix?

Type: SourceNatIpv6Prefix (optional, default: undefined - AWS default is SourceNatIpv6Prefix.autoAssigned() for IPv6 load balancers)

The IPv6 prefix to use for source NAT for a dual-stack network load balancer with UDP listeners.

Specify an IPv6 prefix (/80 netmask) from the subnet CIDR block or SourceNatIpv6Prefix.autoAssigned() to use an IPv6 prefix selected at random from the subnet CIDR block.