Class: Aws::EC2::NetworkAcl
- Inherits:
-
Object
- Object
- Aws::EC2::NetworkAcl
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-ec2/network_acl.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#associations ⇒ Array<Types::NetworkAclAssociation>
Any associations between the network ACL and one or more subnets.
-
#entries ⇒ Array<Types::NetworkAclEntry>
One or more entries (rules) in the network ACL.
- #id ⇒ String (also: #network_acl_id)
-
#is_default ⇒ Boolean
Indicates whether this is the default network ACL for the VPC.
-
#owner_id ⇒ String
The ID of the AWS account that owns the network ACL.
-
#tags ⇒ Array<Types::Tag>
Any tags assigned to the network ACL.
-
#vpc_id ⇒ String
The ID of the VPC for the network ACL.
Actions collapse
- #create_entry(options = {}) ⇒ EmptyStructure
- #create_tags(options = {}) ⇒ Tag::Collection
- #delete(options = {}) ⇒ EmptyStructure
- #delete_entry(options = {}) ⇒ EmptyStructure
- #replace_association(options = {}) ⇒ Types::ReplaceNetworkAclAssociationResult
- #replace_entry(options = {}) ⇒ EmptyStructure
Associations collapse
- #identifiers ⇒ Object deprecated private Deprecated.
- #vpc ⇒ Vpc?
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::NetworkAcl
Returns the data for this NetworkAcl.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ NetworkAcl
constructor
A new instance of NetworkAcl.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current NetworkAcl.
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::EC2::Client] #wait_until instead
Constructor Details
#initialize(id, options = {}) ⇒ NetworkAcl #initialize(options = {}) ⇒ NetworkAcl
Returns a new instance of NetworkAcl.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-ec2/network_acl.rb', line 19 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @id = extract_id(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() end |
Instance Method Details
#associations ⇒ Array<Types::NetworkAclAssociation>
Any associations between the network ACL and one or more subnets
36 37 38 |
# File 'lib/aws-sdk-ec2/network_acl.rb', line 36 def associations data[:associations] end |
#create_entry(options = {}) ⇒ EmptyStructure
261 262 263 264 265 |
# File 'lib/aws-sdk-ec2/network_acl.rb', line 261 def create_entry( = {}) = .merge(network_acl_id: @id) resp = @client.create_network_acl_entry() resp.data end |
#create_tags(options = {}) ⇒ Tag::Collection
289 290 291 292 293 294 295 296 297 298 299 300 301 302 |
# File 'lib/aws-sdk-ec2/network_acl.rb', line 289 def ( = {}) batch = [] = Aws::Util.deep_merge(, resources: [@id]) resp = @client.() [: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 |
#data ⇒ Types::NetworkAcl
Returns the data for this Aws::EC2::NetworkAcl. Calls Client#describe_network_acls if #data_loaded? is ‘false`.
93 94 95 96 |
# File 'lib/aws-sdk-ec2/network_acl.rb', line 93 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
101 102 103 |
# File 'lib/aws-sdk-ec2/network_acl.rb', line 101 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
316 317 318 319 320 |
# File 'lib/aws-sdk-ec2/network_acl.rb', line 316 def delete( = {}) = .merge(network_acl_id: @id) resp = @client.delete_network_acl() resp.data end |
#delete_entry(options = {}) ⇒ EmptyStructure
340 341 342 343 344 |
# File 'lib/aws-sdk-ec2/network_acl.rb', line 340 def delete_entry( = {}) = .merge(network_acl_id: @id) resp = @client.delete_network_acl_entry() resp.data end |
#entries ⇒ Array<Types::NetworkAclEntry>
One or more entries (rules) in the network ACL.
42 43 44 |
# File 'lib/aws-sdk-ec2/network_acl.rb', line 42 def entries data[:entries] end |
#id ⇒ String Also known as: network_acl_id
29 30 31 |
# File 'lib/aws-sdk-ec2/network_acl.rb', line 29 def id @id end |
#identifiers ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
446 447 448 |
# File 'lib/aws-sdk-ec2/network_acl.rb', line 446 def identifiers { id: @id } end |
#is_default ⇒ Boolean
Indicates whether this is the default network ACL for the VPC.
48 49 50 |
# File 'lib/aws-sdk-ec2/network_acl.rb', line 48 def is_default data[:is_default] end |
#load ⇒ self 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
83 84 85 86 87 |
# File 'lib/aws-sdk-ec2/network_acl.rb', line 83 def load resp = @client.describe_network_acls(network_acl_ids: [@id]) @data = resp.network_acls[0] self end |
#owner_id ⇒ String
The ID of the AWS account that owns the network ACL.
66 67 68 |
# File 'lib/aws-sdk-ec2/network_acl.rb', line 66 def owner_id data[:owner_id] end |
#replace_association(options = {}) ⇒ Types::ReplaceNetworkAclAssociationResult
362 363 364 365 366 |
# File 'lib/aws-sdk-ec2/network_acl.rb', line 362 def replace_association( = {}) = .merge(network_acl_id: @id) resp = @client.replace_network_acl_association() resp.data end |
#replace_entry(options = {}) ⇒ EmptyStructure
424 425 426 427 428 |
# File 'lib/aws-sdk-ec2/network_acl.rb', line 424 def replace_entry( = {}) = .merge(network_acl_id: @id) resp = @client.replace_network_acl_entry() resp.data end |
#tags ⇒ Array<Types::Tag>
Any tags assigned to the network ACL.
54 55 56 |
# File 'lib/aws-sdk-ec2/network_acl.rb', line 54 def data[:tags] end |
#vpc ⇒ Vpc?
433 434 435 436 437 438 439 440 441 442 |
# File 'lib/aws-sdk-ec2/network_acl.rb', line 433 def vpc if data[:vpc_id] Vpc.new( id: data[:vpc_id], client: @client ) else nil end end |
#vpc_id ⇒ String
The ID of the VPC for the network ACL.
60 61 62 |
# File 'lib/aws-sdk-ec2/network_acl.rb', line 60 def vpc_id data[:vpc_id] end |
#wait_until(options = {}, &block) ⇒ Resource
Use [Aws::EC2::Client] #wait_until instead
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() {|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
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/aws-sdk-ec2/network_acl.rb', line 183 def wait_until( = {}, &block) self_copy = self.dup attempts = 0 [:max_attempts] = 10 unless .key?(:max_attempts) [:delay] ||= 10 [:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == [:max_attempts] :retry end end Aws::Waiters::Waiter.new().wait({}) end |