You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EC2::Types::CreateNetworkAclEntryRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass CreateNetworkAclEntryRequest data as a hash:

{
  cidr_block: "String",
  dry_run: false,
  egress: false, # required
  icmp_type_code: {
    code: 1,
    type: 1,
  },
  ipv_6_cidr_block: "String",
  network_acl_id: "String", # required
  port_range: {
    from: 1,
    to: 1,
  },
  protocol: "String", # required
  rule_action: "allow", # required, accepts allow, deny
  rule_number: 1, # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#cidr_blockString

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

Returns:

  • (String)


5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5754

class CreateNetworkAclEntryRequest < Struct.new(
  :cidr_block,
  :dry_run,
  :egress,
  :icmp_type_code,
  :ipv_6_cidr_block,
  :network_acl_id,
  :port_range,
  :protocol,
  :rule_action,
  :rule_number)
  include Aws::Structure
end

#dry_runBoolean

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.

Returns:

  • (Boolean)


5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5754

class CreateNetworkAclEntryRequest < Struct.new(
  :cidr_block,
  :dry_run,
  :egress,
  :icmp_type_code,
  :ipv_6_cidr_block,
  :network_acl_id,
  :port_range,
  :protocol,
  :rule_action,
  :rule_number)
  include Aws::Structure
end

#egressBoolean

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

Returns:

  • (Boolean)


5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5754

class CreateNetworkAclEntryRequest < Struct.new(
  :cidr_block,
  :dry_run,
  :egress,
  :icmp_type_code,
  :ipv_6_cidr_block,
  :network_acl_id,
  :port_range,
  :protocol,
  :rule_action,
  :rule_number)
  include Aws::Structure
end

#icmp_type_codeTypes::IcmpTypeCode

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

Returns:



5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5754

class CreateNetworkAclEntryRequest < Struct.new(
  :cidr_block,
  :dry_run,
  :egress,
  :icmp_type_code,
  :ipv_6_cidr_block,
  :network_acl_id,
  :port_range,
  :protocol,
  :rule_action,
  :rule_number)
  include Aws::Structure
end

#ipv_6_cidr_blockString

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

Returns:

  • (String)


5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5754

class CreateNetworkAclEntryRequest < Struct.new(
  :cidr_block,
  :dry_run,
  :egress,
  :icmp_type_code,
  :ipv_6_cidr_block,
  :network_acl_id,
  :port_range,
  :protocol,
  :rule_action,
  :rule_number)
  include Aws::Structure
end

#network_acl_idString

The ID of the network ACL.

Returns:

  • (String)


5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5754

class CreateNetworkAclEntryRequest < Struct.new(
  :cidr_block,
  :dry_run,
  :egress,
  :icmp_type_code,
  :ipv_6_cidr_block,
  :network_acl_id,
  :port_range,
  :protocol,
  :rule_action,
  :rule_number)
  include Aws::Structure
end

#port_rangeTypes::PortRange

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

Returns:



5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5754

class CreateNetworkAclEntryRequest < Struct.new(
  :cidr_block,
  :dry_run,
  :egress,
  :icmp_type_code,
  :ipv_6_cidr_block,
  :network_acl_id,
  :port_range,
  :protocol,
  :rule_action,
  :rule_number)
  include Aws::Structure
end

#protocolString

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.

Returns:

  • (String)


5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5754

class CreateNetworkAclEntryRequest < Struct.new(
  :cidr_block,
  :dry_run,
  :egress,
  :icmp_type_code,
  :ipv_6_cidr_block,
  :network_acl_id,
  :port_range,
  :protocol,
  :rule_action,
  :rule_number)
  include Aws::Structure
end

#rule_actionString

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

Returns:

  • (String)


5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5754

class CreateNetworkAclEntryRequest < Struct.new(
  :cidr_block,
  :dry_run,
  :egress,
  :icmp_type_code,
  :ipv_6_cidr_block,
  :network_acl_id,
  :port_range,
  :protocol,
  :rule_action,
  :rule_number)
  include Aws::Structure
end

#rule_numberInteger

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.

Returns:

  • (Integer)


5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5754

class CreateNetworkAclEntryRequest < Struct.new(
  :cidr_block,
  :dry_run,
  :egress,
  :icmp_type_code,
  :ipv_6_cidr_block,
  :network_acl_id,
  :port_range,
  :protocol,
  :rule_action,
  :rule_number)
  include Aws::Structure
end