Skip to content

EC2  >  Operations  >  create_network_acl_entry

create_network_acl_entry

Operation

create_network_acl_entry async

create_network_acl_entry(request: CreateNetworkAclEntryInput | CreateNetworkAclEntryInputDict, /, *, plugins: list[Plugin] | None = None) -> CreateNetworkAclEntryOutput
create_network_acl_entry(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateNetworkAclEntryInputDict]) -> CreateNetworkAclEntryOutput

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 VPC User Guide.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
CreateNetworkAclEntryOutput

An instance of CreateNetworkAclEntryOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

CreateNetworkAclEntryInput dataclass

Bases: _SerdeShape

Dataclass for CreateNetworkAclEntryInput structure.

Attributes
cidr_block class-attribute instance-attribute
cidr_block: str | None = ...

The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

egress class-attribute instance-attribute
egress: bool | None = ...

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

icmp_type_code class-attribute instance-attribute
icmp_type_code: IcmpTypeCode | None = ...

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

ipv6_cidr_block class-attribute instance-attribute
ipv6_cidr_block: str | None = ...

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

network_acl_id class-attribute instance-attribute
network_acl_id: str | None = ...

The ID of the network ACL.

port_range class-attribute instance-attribute
port_range: PortRange | None = ...

TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).

protocol class-attribute instance-attribute
protocol: str | None = ...

The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that 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.

rule_action class-attribute instance-attribute
rule_action: str | None = ...

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

rule_number class-attribute instance-attribute
rule_number: int | None = ...

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.

Dictionaries

CreateNetworkAclEntryInputDict

Bases: TypedDict

Dictionary form of CreateNetworkAclEntryInput.

Attributes
cidr_block instance-attribute
cidr_block: str | None

The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

dry_run instance-attribute
dry_run: bool | None

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.

egress instance-attribute
egress: Required[bool]

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

icmp_type_code instance-attribute
icmp_type_code: IcmpTypeCode | IcmpTypeCodeDict | None

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

ipv6_cidr_block instance-attribute
ipv6_cidr_block: str | None

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

network_acl_id instance-attribute
network_acl_id: Required[str]

The ID of the network ACL.

port_range instance-attribute
port_range: PortRange | PortRangeDict | None

TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).

protocol instance-attribute
protocol: Required[str]

The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that 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.

rule_action instance-attribute
rule_action: Required[str]

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

rule_number instance-attribute
rule_number: Required[int]

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.

Output

CreateNetworkAclEntryOutput dataclass

Bases: _SerdeShape

Dataclass for CreateNetworkAclEntryOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.