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

Class: Aws::EC2::NetworkAcl

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

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, options = {}) ⇒ NetworkAcl #initialize(options = {}) ⇒ NetworkAcl

Returns a new instance of NetworkAcl

Overloads:

  • #initialize(id, options = {}) ⇒ NetworkAcl

    Parameters:

    • id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ NetworkAcl

    Options Hash (options):

    • :id (required, String)
    • :client (Client)


19
20
21
22
23
24
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_acl.rb', line 19

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @id = extract_id(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#associationsArray<Types::NetworkAclAssociation>

Any associations between the network ACL and one or more subnets

Returns:



36
37
38
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_acl.rb', line 36

def associations
  data[:associations]
end

#clientClient

Returns:



67
68
69
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_acl.rb', line 67

def client
  @client
end

#create_entry(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


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

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :cidr_block (String)

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

  • :dry_run (Boolean)

    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 (required, Boolean)

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

  • :icmp_type_code (Types::IcmpTypeCode)

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

  • :ipv_6_cidr_block (String)

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

  • :port_range (Types::PortRange)

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

  • :protocol (required, String)

    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.

  • :rule_action (required, String)

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

  • :rule_number (required, Integer)

    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:

  • (EmptyStructure)


254
255
256
257
258
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_acl.rb', line 254

def create_entry(options = {})
  options = options.merge(network_acl_id: @id)
  resp = @client.create_network_acl_entry(options)
  resp.data
end

#create_tags(options = {}) ⇒ Tag::Collection

Examples:

Request syntax with placeholder values


tag = network_acl.create_tags({
  dry_run: false,
  tags: [ # required
    {
      key: "String",
      value: "String",
    },
  ],
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :dry_run (Boolean)

    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.

  • :tags (required, Array<Types::Tag>)

    One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

Returns:



282
283
284
285
286
287
288
289
290
291
292
293
294
295
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_acl.rb', line 282

def create_tags(options = {})
  batch = []
  options = Aws::Util.deep_merge(options, resources: [@id])
  resp = @client.create_tags(options)
  options[:tags].each do |t|
    batch << Tag.new(
      resource_id: @id,
      key: t[:key],
      value: t[:value],
      client: @client
    )
  end
  Tag::Collection.new([batch], size: batch.size)
end

#dataTypes::NetworkAcl

Returns the data for this Aws::EC2::NetworkAcl. Calls Client#describe_network_acls if #data_loaded? is false.

Returns:



87
88
89
90
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_acl.rb', line 87

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



95
96
97
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_acl.rb', line 95

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


network_acl.delete({
  dry_run: false,
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :dry_run (Boolean)

    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:

  • (EmptyStructure)


309
310
311
312
313
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_acl.rb', line 309

def delete(options = {})
  options = options.merge(network_acl_id: @id)
  resp = @client.delete_network_acl(options)
  resp.data
end

#delete_entry(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


network_acl.delete_entry({
  dry_run: false,
  egress: false, # required
  rule_number: 1, # required
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :dry_run (Boolean)

    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 (required, Boolean)

    Indicates whether the rule is an egress rule.

  • :rule_number (required, Integer)

    The rule number of the entry to delete.

Returns:

  • (EmptyStructure)


333
334
335
336
337
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_acl.rb', line 333

def delete_entry(options = {})
  options = options.merge(network_acl_id: @id)
  resp = @client.delete_network_acl_entry(options)
  resp.data
end

#entriesArray<Types::NetworkAclEntry>

One or more entries (rules) in the network ACL.

Returns:



42
43
44
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_acl.rb', line 42

def entries
  data[:entries]
end

#idString Also known as: network_acl_id

Returns:

  • (String)


29
30
31
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_acl.rb', line 29

def id
  @id
end

#is_defaultBoolean

Indicates whether this is the default network ACL for the VPC.

Returns:

  • (Boolean)


48
49
50
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_acl.rb', line 48

def is_default
  data[:is_default]
end

#loadself Also known as: reload

Loads, or reloads #data for the current Aws::EC2::NetworkAcl. Returns self making it possible to chain methods.

network_acl.reload.data

Returns:

  • (self)


77
78
79
80
81
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_acl.rb', line 77

def load
  resp = @client.describe_network_acls(network_acl_ids: [@id])
  @data = resp.network_acls[0]
  self
end

#replace_association(options = {}) ⇒ Types::ReplaceNetworkAclAssociationResult

Examples:

Request syntax with placeholder values


network_acl.replace_association({
  association_id: "String", # required
  dry_run: false,
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :association_id (required, String)

    The ID of the current association between the original network ACL and the subnet.

  • :dry_run (Boolean)

    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:



355
356
357
358
359
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_acl.rb', line 355

def replace_association(options = {})
  options = options.merge(network_acl_id: @id)
  resp = @client.replace_network_acl_association(options)
  resp.data
end

#replace_entry(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


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

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :cidr_block (String)

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

  • :dry_run (Boolean)

    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 (required, Boolean)

    Indicates whether to replace the egress rule.

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

  • :icmp_type_code (Types::IcmpTypeCode)

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

  • :ipv_6_cidr_block (String)

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

  • :port_range (Types::PortRange)

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

  • :protocol (required, String)

    The IP protocol. You can specify all or -1 to mean 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.

  • :rule_action (required, String)

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

  • :rule_number (required, Integer)

    The rule number of the entry to replace.

Returns:

  • (EmptyStructure)


417
418
419
420
421
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_acl.rb', line 417

def replace_entry(options = {})
  options = options.merge(network_acl_id: @id)
  resp = @client.replace_network_acl_entry(options)
  resp.data
end

#tagsArray<Types::Tag>

Any tags assigned to the network ACL.

Returns:



54
55
56
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_acl.rb', line 54

def tags
  data[:tags]
end

#vpcVpc?

Returns:



426
427
428
429
430
431
432
433
434
435
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_acl.rb', line 426

def vpc
  if data[:vpc_id]
    Vpc.new(
      id: data[:vpc_id],
      client: @client
    )
  else
    nil
  end
end

#vpc_idString

The ID of the VPC for the network ACL.

Returns:

  • (String)


60
61
62
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_acl.rb', line 60

def vpc_id
  data[:vpc_id]
end

#wait_until(options = {}, &block) ⇒ Resource

Deprecated.

Use [Aws::EC2::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged

Waiter polls an API operation until a resource enters a desired state.

Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

Example

instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10

    Maximum number of

  • :delay (Integer) — default: 10

    Delay between each

  • :before_attempt (Proc) — default: nil

    Callback

  • :before_wait (Proc) — default: nil

    Callback

Returns:

  • (Resource)

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError)

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError)

    Raised when the resource does not



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_acl.rb', line 177

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Waiters::Waiter.new(options).wait({})
end