SubnetFilter Class
Contains logic which chooses a set of subnets from a larger list, in conjunction with SubnetSelection, to determine where to place AWS resources such as VPC endpoints, EC2 instances, etc.
Example
ts
// 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';
const subnetFilter = ec2.SubnetFilter.availabilityZones(['availabilityZones']);
Initializer
ts
new SubnetFilter()
python
SubnetFilter()
java
new SubnetFilter()
csharp
new SubnetFilter()
go
NewSubnetFilter()
Methods
availabilityZones(availabilityZones: string[]): SubnetFilter // chainable@staticmethod def availability_zones(availability_zones: typing.List[str]) -> SubnetFilterpublic static SubnetFilter availabilityZones(List<String> availabilityZones)public static SubnetFilter AvailabilityZones(string[] availabilityZones)func AvailabilityZones(AvailabilityZones *[]*string) SubnetFilterstatic#Chooses subnets which are in one of the given availability zones.
byCidrMask(mask: number): SubnetFilter // chainable@staticmethod def by_cidr_mask(mask: int | float) -> SubnetFilterpublic static SubnetFilter byCidrMask(Number mask)public static SubnetFilter ByCidrMask(double mask)func ByCidrMask(Mask *float64) SubnetFilterstatic#Chooses subnets which have the provided CIDR netmask.
byCidrRanges(cidrs: string[]): SubnetFilter // chainable@staticmethod def by_cidr_ranges(cidrs: typing.List[str]) -> SubnetFilterpublic static SubnetFilter byCidrRanges(List<String> cidrs)public static SubnetFilter ByCidrRanges(string[] cidrs)func ByCidrRanges(Cidrs *[]*string) SubnetFilterstatic#Chooses subnets which are inside any of the specified CIDR range.
1 parameter
Parameters
cidrscidrscidrscidrsCidrs— List of CIDR ranges to filter subnets from.
byIds(subnetIds: string[]): SubnetFilter // chainable@staticmethod def by_ids(subnet_ids: typing.List[str]) -> SubnetFilterpublic static SubnetFilter byIds(List<String> subnetIds)public static SubnetFilter ByIds(string[] subnetIds)func ByIds(SubnetIds *[]*string) SubnetFilterstatic#Chooses subnets by id.
containsIpAddresses(ipv4addrs: string[]): SubnetFilter // chainable@staticmethod def contains_ip_addresses(ipv4addrs: typing.List[str]) -> SubnetFilterpublic static SubnetFilter containsIpAddresses(List<String> ipv4addrs)public static SubnetFilter ContainsIpAddresses(string[] ipv4addrs)func ContainsIpAddresses(Ipv4addrs *[]*string) SubnetFilterstatic#Chooses subnets which contain any of the specified IP addresses.
onePerAz(): SubnetFilter // chainable@staticmethod def one_per_az() -> SubnetFilterpublic static SubnetFilter onePerAz()public static SubnetFilter OnePerAz()func OnePerAz() SubnetFilterstatic#Chooses subnets such that there is at most one per availability zone.
selectSubnets(_subnets: ISubnet[]): ISubnet[]def select_subnets(self, _subnets: typing.List[ISubnet]) -> typing.List[ISubnet]public List<ISubnet> selectSubnets(List<ISubnet> _subnets)public ISubnet[] SelectSubnets(ISubnet[] _subnets)func SelectSubnets(_subnets *[]ISubnet) *[]ISubnet#Executes the subnet filtering logic, returning a filtered set of subnets.