Class: Aws::EC2::SecurityGroup
- Inherits:
-
Object
- Object
- Aws::EC2::SecurityGroup
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-ec2/security_group.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#description ⇒ String
A description of the security group.
-
#group_name ⇒ String
The name of the security group.
- #id ⇒ String (also: #group_id)
-
#ip_permissions ⇒ Array<Types::IpPermission>
One or more inbound rules associated with the security group.
-
#ip_permissions_egress ⇒ Array<Types::IpPermission>
[EC2-VPC] One or more outbound rules associated with the security group.
-
#owner_id ⇒ String
The AWS account ID of the owner of the security group.
-
#tags ⇒ Array<Types::Tag>
Any tags assigned to the security group.
-
#vpc_id ⇒ String
[EC2-VPC] The ID of the VPC for the security group.
Actions collapse
- #authorize_egress(options = {}) ⇒ EmptyStructure
- #authorize_ingress(options = {}) ⇒ EmptyStructure
- #create_tags(options = {}) ⇒ Tag::Collection
- #delete(options = {}) ⇒ EmptyStructure
- #identifiers ⇒ Object deprecated private Deprecated.
- #revoke_egress(options = {}) ⇒ EmptyStructure
- #revoke_ingress(options = {}) ⇒ EmptyStructure
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::SecurityGroup
Returns the data for this SecurityGroup.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ SecurityGroup
constructor
A new instance of SecurityGroup.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current SecurityGroup.
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::EC2::Client] #wait_until instead
Constructor Details
#initialize(id, options = {}) ⇒ SecurityGroup #initialize(options = {}) ⇒ SecurityGroup
Returns a new instance of SecurityGroup.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-ec2/security_group.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
#authorize_egress(options = {}) ⇒ EmptyStructure
282 283 284 285 286 |
# File 'lib/aws-sdk-ec2/security_group.rb', line 282 def ( = {}) = .merge(group_id: @id) resp = @client.() resp.data end |
#authorize_ingress(options = {}) ⇒ EmptyStructure
391 392 393 394 395 |
# File 'lib/aws-sdk-ec2/security_group.rb', line 391 def ( = {}) = .merge(group_id: @id) resp = @client.() resp.data end |
#client ⇒ Client
80 81 82 |
# File 'lib/aws-sdk-ec2/security_group.rb', line 80 def client @client end |
#create_tags(options = {}) ⇒ Tag::Collection
419 420 421 422 423 424 425 426 427 428 429 430 431 432 |
# File 'lib/aws-sdk-ec2/security_group.rb', line 419 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::SecurityGroup
Returns the data for this Aws::EC2::SecurityGroup. Calls Client#describe_security_groups if #data_loaded? is ‘false`.
100 101 102 103 |
# File 'lib/aws-sdk-ec2/security_group.rb', line 100 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
108 109 110 |
# File 'lib/aws-sdk-ec2/security_group.rb', line 108 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
450 451 452 453 454 |
# File 'lib/aws-sdk-ec2/security_group.rb', line 450 def delete( = {}) = .merge(group_id: @id) resp = @client.delete_security_group() resp.data end |
#description ⇒ String
A description of the security group.
36 37 38 |
# File 'lib/aws-sdk-ec2/security_group.rb', line 36 def description data[:description] end |
#group_name ⇒ String
The name of the security group.
42 43 44 |
# File 'lib/aws-sdk-ec2/security_group.rb', line 42 def group_name data[:group_name] end |
#id ⇒ String Also known as: group_id
29 30 31 |
# File 'lib/aws-sdk-ec2/security_group.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.
638 639 640 |
# File 'lib/aws-sdk-ec2/security_group.rb', line 638 def identifiers { id: @id } end |
#ip_permissions ⇒ Array<Types::IpPermission>
One or more inbound rules associated with the security group.
48 49 50 |
# File 'lib/aws-sdk-ec2/security_group.rb', line 48 def data[:ip_permissions] end |
#ip_permissions_egress ⇒ Array<Types::IpPermission>
[EC2-VPC] One or more outbound rules associated with the security group.
61 62 63 |
# File 'lib/aws-sdk-ec2/security_group.rb', line 61 def data[:ip_permissions_egress] end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::EC2::SecurityGroup. Returns ‘self` making it possible to chain methods.
security_group.reload.data
90 91 92 93 94 |
# File 'lib/aws-sdk-ec2/security_group.rb', line 90 def load resp = @client.describe_security_groups(group_ids: [@id]) @data = resp.security_groups[0] self end |
#owner_id ⇒ String
The AWS account ID of the owner of the security group.
54 55 56 |
# File 'lib/aws-sdk-ec2/security_group.rb', line 54 def owner_id data[:owner_id] end |
#revoke_egress(options = {}) ⇒ EmptyStructure
529 530 531 532 533 |
# File 'lib/aws-sdk-ec2/security_group.rb', line 529 def revoke_egress( = {}) = .merge(group_id: @id) resp = @client.revoke_security_group_egress() resp.data end |
#revoke_ingress(options = {}) ⇒ EmptyStructure
630 631 632 633 634 |
# File 'lib/aws-sdk-ec2/security_group.rb', line 630 def revoke_ingress( = {}) = .merge(group_id: @id) resp = @client.revoke_security_group_ingress() resp.data end |
#tags ⇒ Array<Types::Tag>
Any tags assigned to the security group.
67 68 69 |
# File 'lib/aws-sdk-ec2/security_group.rb', line 67 def data[:tags] end |
#vpc_id ⇒ String
[EC2-VPC] The ID of the VPC for the security group.
73 74 75 |
# File 'lib/aws-sdk-ec2/security_group.rb', line 73 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
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 |
# File 'lib/aws-sdk-ec2/security_group.rb', line 190 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 |