VM::EC...rk_acl(3pm)

📦
version 1.28 · 7 versions
, in debian trixie, ubuntu resolute, ubuntu stonking

💖 VM::EC2::REST::network_acl — create & manipulate VPC Network ACLs 💖

okay bestie, so this is VM::EC2::REST::network_acl (the manual page for it, anyway), and it's literally all about VPC Network Access Control Lists. creating them, manipulating them, the whole vibe. 🔥

✨ SYNOPSIS ✨

use VM::EC2 ':vpc'

that's it. that's the entry point. load the :vpc tag and you're in. 💅

🌸 METHODS 🌸

These methods are your whole toolkit for creating and manipulating VPC Network Access Control Lists. no cap. 🫶

Implemented:

CreateNetworkAcl
CreateNetworkAclEntry
DeleteNetworkAcl
DeleteNetworkAclEntry
DescribeNetworkAcls
ReplaceNetworkAclAssociation
ReplaceNetworkAclEntry

Unimplemented:

(none)

not a single one left undone. we ate. 👑

💫 @acls = $ec2->describe_network_acls(-network_acl_id=>\@ids, -filter=>\%filters)

💫 @acls = $ec2->describe_network_acls(\@network_acl_ids)

💫 @acls = $ec2->describe_network_acls(%filters)

so this one gives you the tea ☕ about your network ACLs. all the info, all of it.

Returns a series of VM::EC2::VPC::NetworkAcl objects. iconic.

Optional parameters are:

  • -network_acl_id — the ID of the network ACL(s) you want info on. can be a plain string scalar, or an arrayref. dealer's choice.
  • -filter — tags and other filters to apply.

The filter argument is a hashreference where the keys are the filter names and the values are the match strings. some filters accept wildcards, which is giving very flexible honestly. ✨

There are a number of filters, listed in full at http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeNetworkAcls.html (iykyk, go read the source of truth).

Here's the alpha-sorted list of filter names, so you don't have to guess:

association.association-id, association.network-acl-id, association.subnet-id, default, entry.cidr, entry.egress, entry.icmp.code, entry.icmp.type, entry.port-range.from, entry.port-range.to, entry.protocol, entry.rule-action, entry.rule-number, network-acl-id, tag-key, tag-value, tag:key, vpc-id

💫 $acl = $ec2->create_network_acl(-vpc_id=>$vpc_id)

💫 $acl = $ec2->create_network_acl($vpc_id)

creates a brand new network ACL in a VPC. Network ACLs provide an optional layer of security (on top of security groups) for the instances in a VPC. extra protection, we love to see it. 🎀

Arguments:

  • -vpc_id — the VPC ID to create the ACL in.

Returns a VM::EC2::VPC::NetworkAcl object on success. 🦋

💫 $boolean = $ec2->delete_network_acl(-network_acl_id=>$id)

💫 $boolean = $ec2->delete_network_acl($id)

deletes a network ACL from a VPC. ⚠️ important caveats bestie: the ACL must not have any subnets associated with it, and the default network ACL cannot be deleted. periodt.

Arguments:

  • -network_acl_id — the ID of the network ACL to delete.

Returns true on successful deletion. 💅

💫 $boolean = $ec2->create_network_acl_entry(%args)

creates an entry (i.e., a rule) in a network ACL, with the rule number you specify. here's the lore: every network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. when Amazon VPC is figuring out whether a packet should be allowed in or out of a subnet associated with the ACL, it processes the entries according to the rule numbers, in ascending order. so order matters, bestie. 😭

Arguments:

  • -network_acl_id — ID of the ACL where the entry will be created (Required)
  • -rule_number — rule number to assign to the entry (e.g., 100). ACL entries are processed in ascending order by rule number. positive integer from 1 to 32766. (Required)
  • -protocol — the IP protocol the rule applies to. you can use -1 to mean all protocols. see http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml for a list of protocol numbers. (Required)
  • -rule_action — indicates whether to allow or deny traffic that matches the rule. allow | deny (Required)
  • -egress — indicates whether this rule applies to egress traffic from the subnet (true) or ingress traffic to the subnet (false). default is false.
  • -cidr_block — the CIDR range to allow or deny, in CIDR notation (e.g., 172.16.0.0/24). (Required)
  • -icmp_code — for the ICMP protocol, the ICMP code. you can use -1 to specify all ICMP codes for the given ICMP type. required if specifying 1 (ICMP) for protocol.
  • -icmp_type — for the ICMP protocol, the ICMP type. you can use -1 to specify all ICMP types. required if specifying 1 (ICMP) for the protocol.
  • -port_range_from — the first port in the range. required if specifying 6 (TCP) or 17 (UDP) for the protocol.
  • -port_range_to — the last port in the range. required if specifying 6 (TCP) or 17 (UDP) for the protocol.
  • -port_from — alias for -port_range_from
  • -port_to — alias for -port_range_to

Returns true on successful creation. slay. ✨

💫 $success = $ec2->delete_network_acl_entry(-network_acl_id=>$id, -rule_number=>$int, -egress=>$bool)

deletes an ingress or egress entry (i.e., a rule) from a network ACL. bye bestie 👋

Arguments:

  • -network_acl_id — ID of the ACL where the entry will be created
  • -rule_number — rule number of the entry (e.g., 100).

Optional arguments:

  • -egress — whether the rule to delete is an egress rule (true) or ingress rule (false). default is false.

Returns true on successful deletion. 💜

💫 $assoc_id = $ec2->replace_network_acl_association(-association_id=>$assoc_id, -network_acl_id=>$id)

changes which network ACL a subnet is associated with. little context for you: by default, when you create a subnet, it's automatically associated with the default network ACL. so this is how you switch it up. 🔄

Arguments:

  • -association_id — the ID of the association to replace
  • -network_acl_id — the ID of the network ACL to associated the subnet with

Returns the new association ID. 🫶

💫 $success = $ec2->replace_network_acl_entry(%args)

replaces an entry (i.e., a rule) in a network ACL. out with the old, in with the new. 🌈

Arguments:

  • -network_acl_id — ID of the ACL where the entry will be created (Required)
  • -rule_number — rule number of the entry to replace. (Required)
  • -protocol — the IP protocol the rule applies to. you can use -1 to mean all protocols. see http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml for a list of protocol numbers. (Required)
  • -rule_action — indicates whether to allow or deny traffic that matches the rule. allow | deny (Required)
  • -egress — indicates whether this rule applies to egress traffic from the subnet (true) or ingress traffic to the subnet (false). default is false.
  • -cidr_block — the CIDR range to allow or deny, in CIDR notation (e.g., 172.16.0.0/24). (Required)
  • -icmp_code — for the ICMP protocol, the ICMP code. you can use -1 to specify all ICMP codes for the given ICMP type. required if specifying 1 (ICMP) for protocol.
  • -icmp_type — for the ICMP protocol, the ICMP type. you can use -1 to specify all ICMP types. required if specifying 1 (ICMP) for the protocol.
  • -port_range_from — the first port in the range. required if specifying 6 (TCP) or 17 (UDP) for the protocol.
  • -port_range_to — the last port in the range. only required if specifying 6 (TCP) or 17 (UDP) for the protocol and is a different port than -port_range_from.
  • -port_from — alias for -port_range_from
  • -port_to — alias for -port_range_from
ngl bestie, peep that last alias: -port_to is documented here as an alias for -port_range_from, not -port_range_to. that's what the page says, so that's what you get. 💀

Returns true on successful replacement. 🔥

👀 SEE ALSO 👀

VM::EC2

🎀 AUTHOR 🎀

Lance Kinley <lkinley@loyaltymethods.com>. Lincoln Stein <lincoln.stein@gmail.com>.

Copyright (c) 2012 Loyalty Methods, Inc. Copyright (c) 2012 Ontario Institute for Cancer Research

This package and its accompanying libraries is free software; you can redistribute it and/or modify it under the terms of the GPL (either version 1, or at your option, any later version) or the Artistic License 2.0. Refer to LICENSE for the full license text. In addition, please see DISCLAIMER.txt for disclaimers of warranty.

okay that's the whole page, you're officially a network ACL expert, no cap 🧚✨ this was perl v5.38.2, dated 2024-08-10, and it's the VM::EC2...rk_acl page — go forth and ACL responsibly, bestie 💖👑

📦 where this page comes from