Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

CreateNetworkAclEntry

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL 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 ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

CidrBlock

The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).

Type: String

Required: No

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Type: Boolean

Required: No

Egress

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

Type: Boolean

Required: Yes

Icmp

ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying the ICMP protocol, or protocol 58 (ICMPv6) with an IPv6 CIDR block.

Type: IcmpTypeCode object

Required: No

Ipv6CidrBlock

The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).

Type: String

Required: No

NetworkAclId

The ID of the network ACL.

Type: String

Required: Yes

PortRange

TCP or UDP protocols: The range of ports the rule applies to.

Type: PortRange object

Required: No

Protocol

The protocol. A value of -1 or all means all protocols. If you specify all, -1, or a protocol number other than tcp, udp, or icmp, traffic on all ports is allowed, regardless of any ports or ICMP types or codes you specify. If you specify protocol 58 (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol 58 (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.

Type: String

Required: Yes

RuleAction

Indicates whether to allow or deny the traffic that matches the rule.

Type: String

Valid Values: allow | deny

Required: Yes

RuleNumber

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.

Type: Integer

Required: Yes

Response Elements

The following elements are returned by the service.

requestId

The ID of the request.

Type: String

return

Is true if the request succeeds, and an error otherwise.

Type: Boolean

Errors

For information about the errors that are common to all actions, see Common Client Errors.

Examples

Example 1

This example creates an entry with rule number 110 in the network ACL with the ID acl-2cb85d45. The rule allows ingress traffic from any IPv4 address (0.0.0.0/0) on UDP port 53.

Sample Request

https://ec2.amazonaws.com/?Action=CreateNetworkAclEntry &NetworkAclId=acl-2cb85d45 &RuleNumber=110 &Protocol=udp &RuleAction=allow &Egress=false &CidrBlock=0.0.0.0/0 &PortRange.From=53 &PortRange.To=53 &AUTHPARAMS

Sample Response

<CreateNetworkAclEntryResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> <return>true</return> </CreateNetworkAclEntryResponse>

Example 2

This example creates an entry with rule number 120 in the network ACL with the ID acl-2cb85d45. The rule allows ingress traffic from any IPv6 address (::/0) on TCP port 80.

Sample Request

https://ec2.amazonaws.com/?Action=CreateNetworkAclEntry &NetworkAclId=acl-2cb85d45 &RuleNumber=120 &Protocol=tcp &RuleAction=allow &Egress=false &Ipv6CidrBlock=::/0 &PortRange.From=80 &PortRange.To=80 &AUTHPARAMS

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: