.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "VM::EC2::VPC::NetworkAcl 3pm"
.TH VM::EC2::VPC::NetworkAcl 3pm "2016-06-04" "perl v5.22.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
VM::EC2::VPC::NetworkAcl \- Virtual Private Cloud network ACL
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use VM::EC2;
\&
\& my $ec2      = VM::EC2\->new(...);
\& my @acls     = $ec2\->describe_network_acls(\-network_acl_id=>\*(Aqacl\-12345678\*(Aq);
\&  foreach my $acl (@acls) {
\&      my $vpc_id  = $acl\->vpcId;
\&      my $default = $acl\->default;
\&      my @entries = $acl\->entries;
\&      my @assoc   = $acl\->associations;
\&      ...
\&  }
\&
\& my $acl      = $ec2\->create_network_acl_entry(...);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This object represents an Amazon \s-1EC2 VPC\s0 network \s-1ACL,\s0 and is returned by
\&\s-1VM::EC2\-\s0>\fIdescribe_network_acls()\fR and \->\fIcreate_network_acl()\fR
.SH "METHODS"
.IX Header "METHODS"
These object methods are supported:
.PP
.Vb 9
\& networkAclId   \-\- The network ACL\*(Aqs ID.
\& vpcId          \-\- The ID of the VPC the network ACL is in.
\& default        \-\- Whether this is the default network ACL in the VPC.
\& entrySet       \-\- A list of entries (rules) in the network ACL.
\& associationSet \-\- A list of associations between the network ACL and
\&                   one or more subnets.
\& tagSet         \-\- Tags assigned to the resource.
\& associations   \-\- Alias for associationSet.
\& entries        \-\- Alias for entrySet.
.Ve
.PP
The object also supports the \fItags()\fR method described in
VM::EC2::Generic:
.SH "CONVENIENCE METHODS"
.IX Header "CONVENIENCE METHODS"
.ie n .SS "$success = $acl\->create_entry(%args) =head2 $success = $acl\->create_entry($acl_entry)"
.el .SS "\f(CW$success\fP = \f(CW$acl\fP\->create_entry(%args) =head2 \f(CW$success\fP = \f(CW$acl\fP\->create_entry($acl_entry)"
.IX Subsection "$success = $acl->create_entry(%args) =head2 $success = $acl->create_entry($acl_entry)"
Creates an entry (i.e., rule) in a network \s-1ACL\s0 with the rule number you
specified. Each network \s-1ACL\s0 has a set of numbered ingress rules and a 
separate set of numbered egress rules. When determining whether a packet
should be allowed in or out of a subnet associated with the \s-1ACL,\s0 Amazon 
\&\s-1VPC\s0 processes the entries in the \s-1ACL\s0 according to the rule numbers, in 
ascending order.
.PP
Arguments:
.PP
.Vb 10
\& \-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_from            \-\- The first port in the range.  Required if specifying
\&                          6 (TCP) or 17 (UDP) for the protocol.
\& \-port_to              \-\- The last port in the range.  Required if specifying
\&                          6 (TCP) or 17 (UDP) for the protocol.
.Ve
.PP
Alternately, can pass an existing \s-1ACL\s0 entry object VM::EC2::VPC::NetworkAcl::Entry
as the only argument for ease in copying entries from one \s-1ACL\s0 to another.
.PP
Returns true on successful creation.
.ie n .SS "$success = $acl\->delete_entry(%args) =head2 $success = $acl\->delete_entry($acl_entry)"
.el .SS "\f(CW$success\fP = \f(CW$acl\fP\->delete_entry(%args) =head2 \f(CW$success\fP = \f(CW$acl\fP\->delete_entry($acl_entry)"
.IX Subsection "$success = $acl->delete_entry(%args) =head2 $success = $acl->delete_entry($acl_entry)"
Deletes an ingress or egress entry (i.e., rule) from a network \s-1ACL.\s0
.PP
Arguments:
.PP
.Vb 1
\& \-network_acl_id       \-\- ID of the ACL where the entry will be created
\&
\& \-rule_number          \-\- Rule number of the entry (e.g., 100).
.Ve
.PP
Optional arguments:
.PP
.Vb 2
\& \-egress    \-\- Whether the rule to delete is an egress rule (true) or ingress 
\&               rule (false).  Default is false.
.Ve
.PP
Alternately, can pass an existing \s-1ACL\s0 entry object VM::EC2::VPC::NetworkAcl::Entry
as the only argument to ease deletion of entries.
.PP
Returns true on successful deletion.
.ie n .SS "$success = replace_entry(%args) =head2 $success = replace_entry($acl_entry)"
.el .SS "\f(CW$success\fP = replace_entry(%args) =head2 \f(CW$success\fP = replace_entry($acl_entry)"
.IX Subsection "$success = replace_entry(%args) =head2 $success = replace_entry($acl_entry)"
Replaces an entry (i.e., rule) in a network \s-1ACL.\s0
.PP
Arguments:
.PP
.Vb 10
\& \-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_from            \-\- The first port in the range.  Required if specifying
\&                          6 (TCP) or 17 (UDP) for the protocol.
\& \-port_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_from.
.Ve
.PP
Alternately, can pass an existing \s-1ACL\s0 entry object VM::EC2::VPC::NetworkAcl::Entry
as the only argument for ease in replacing entries from one \s-1ACL\s0 to another.
The rule number in the passed entry object must already exist in the \s-1ACL.\s0
.PP
Returns true on successful replacement.
.ie n .SS "$association_id = $acl\->associate($subnet_id)"
.el .SS "\f(CW$association_id\fP = \f(CW$acl\fP\->associate($subnet_id)"
.IX Subsection "$association_id = $acl->associate($subnet_id)"
Associates the \s-1ACL\s0 with a subnet in the same \s-1VPC. \s0 Replaces
whatever \s-1ACL\s0 the subnet was associated with previously.
.ie n .SS "$association_id = $acl\->disassociate($subnet_id)"
.el .SS "\f(CW$association_id\fP = \f(CW$acl\fP\->disassociate($subnet_id)"
.IX Subsection "$association_id = $acl->disassociate($subnet_id)"
Disassociates the \s-1ACL\s0 with a subnet in the same \s-1VPC. \s0 The subnet
will then be associated with the default \s-1ACL.\s0
.SH "STRING OVERLOADING"
.IX Header "STRING OVERLOADING"
When used in a string context, this object will interpolate the
networkAclId.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1VM::EC2\s0
VM::EC2::Generic
VM::EC2::Tag
\&\s-1VM::EC2::VPC\s0
VM::EC2::VPC::NetworkAcl::Entry
VM::EC2::VPC::NetworkAcl::Association
.SH "AUTHOR"
.IX Header "AUTHOR"
Lance Kinley <lkinley@loyaltymethods.com>.
.PP
Copyright (c) 2012 Loyalty Methods, Inc.
.PP
This package and its accompanying libraries is free software; you can
redistribute it and/or modify it under the terms of the \s-1GPL \s0(either
version 1, or at your option, any later version) or the Artistic
License 2.0.  Refer to \s-1LICENSE\s0 for the full license text. In addition,
please see \s-1DISCLAIMER\s0.txt for disclaimers of warranty.