Skip to content

replace_network_acl_entry

replace_network_acl_entry(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    network_acl_id: Optional[NetworkAclId] = None,
    rule_number: Optional[Integer] = None,
    protocol: Optional[String] = None,
    rule_action: Optional[RuleAction] = None,
    egress: Optional[Boolean] = None,
    cidr_block: Optional[String] = None,
    ipv6_cidr_block: Optional[String] = None,
    icmp_type_code: Optional[IcmpTypeCode] = None,
    port_range: Optional[PortRange] = None,
) -> None

Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon VPC User Guide.

Parameters:

  • dry_run (Optional[Boolean], default: 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.

  • network_acl_id (Optional[NetworkAclId], default: None ) –

    The ID of the ACL.

  • rule_number (Optional[Integer], default: None ) –

    The rule number of the entry to replace.

  • protocol (Optional[String], default: 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 (Optional[RuleAction], default: None ) –

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

  • egress (Optional[Boolean], default: None ) –

    Indicates whether to replace the egress rule.

    Default: If no value is specified, we replace the ingress rule.

  • cidr_block (Optional[String], default: None ) –

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

  • ipv6_cidr_block (Optional[String], default: None ) –

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

  • icmp_type_code (Optional[IcmpTypeCode], default: 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.

  • port_range (Optional[PortRange], default: None ) –

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

Raises:

Examples:

To replace a network ACL entry This example replaces an entry for the specified network ACL. The new rule 100 allows ingress traffic from 203.0.113.12/24 on UDP port 53 (DNS) into any associated subnet.

>>> client.replace_network_acl_entry(network_acl_id='acl-5fb85d36', rule_number=100, protocol='17', rule_action='allow', egress=False, cidr_block='203.0.113.12/24', port_range={'From': 53, 'To': 53})
Source code in docs_src/capo_ec2/_services/ec2.py
def replace_network_acl_entry(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    network_acl_id: Optional["capo_ec2.types.network_acl_id.NetworkAclId"] = None,
    rule_number: Optional["capo_ec2.types.integer.Integer"] = None,
    protocol: Optional["capo_ec2.types.string.String"] = None,
    rule_action: Optional["capo_ec2.types.rule_action.RuleAction"] = None,
    egress: Optional["capo_ec2.types.boolean.Boolean"] = None,
    cidr_block: Optional["capo_ec2.types.string.String"] = None,
    ipv6_cidr_block: Optional["capo_ec2.types.string.String"] = None,
    icmp_type_code: Optional["capo_ec2.types.icmp_type_code.IcmpTypeCode"] = None,
    port_range: Optional["capo_ec2.types.port_range.PortRange"] = None,
) -> None:
    """<p>Replaces an entry (rule) in a network ACL. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html">Network ACLs</a> in the <i>Amazon VPC User Guide</i>.</p>

    Args:
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        network_acl_id: <p>The ID of the ACL.</p>
        rule_number: <p>The rule number of the entry to replace.</p>
        protocol: <p>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.</p>
        rule_action: <p>Indicates whether to allow or deny the traffic that matches the rule.</p>
        egress: <p>Indicates whether to replace the egress rule.</p> <p>Default: If no value is specified, we replace the ingress rule.</p>
        cidr_block: <p>The IPv4 network range to allow or deny, in CIDR notation (for example <code>172.16.0.0/24</code>).</p>
        ipv6_cidr_block: <p>The IPv6 network range to allow or deny, in CIDR notation (for example <code>2001:bd8:1234:1a00::/64</code>).</p>
        icmp_type_code: <p>ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.</p>
        port_range: <p>TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To replace a network ACL entry
        This example replaces an entry for the specified network ACL. The new rule 100 allows ingress traffic from 203.0.113.12/24 on UDP port 53 (DNS) into any associated subnet.

        >>> client.replace_network_acl_entry(network_acl_id='acl-5fb85d36', rule_number=100, protocol='17', rule_action='allow', egress=False, cidr_block='203.0.113.12/24', port_range={'From': 53, 'To': 53})
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.replace_network_acl_entry_request.ReplaceNetworkAclEntryRequest]",
    ) -> OperationResponse[None]:
        import capo_ec2._operations.amazon_ec2.replace_network_acl_entry

        output, http_response = (
            capo_ec2._operations.amazon_ec2.replace_network_acl_entry.replace_network_acl_entry(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ReplaceNetworkAclEntry")
    )
    input_: capo_ec2.types.replace_network_acl_entry_request.ReplaceNetworkAclEntryRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if network_acl_id is not None:
        input_["network_acl_id"] = network_acl_id
    if rule_number is not None:
        input_["rule_number"] = rule_number
    if protocol is not None:
        input_["protocol"] = protocol
    if rule_action is not None:
        input_["rule_action"] = rule_action
    if egress is not None:
        input_["egress"] = egress
    if cidr_block is not None:
        input_["cidr_block"] = cidr_block
    if ipv6_cidr_block is not None:
        input_["ipv6_cidr_block"] = ipv6_cidr_block
    if icmp_type_code is not None:
        input_["icmp_type_code"] = icmp_type_code
    if port_range is not None:
        input_["port_range"] = port_range

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output