Class: Aws::IAM::Group
- Inherits:
-
Object
- Object
- Aws::IAM::Group
- Defined in:
- gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#arn ⇒ String
The Amazon Resource Name (ARN) specifying the group.
-
#create_date ⇒ Time
The date and time, in [ISO 8601 date-time format][1], when the group was created.
-
#group_id ⇒ String
The stable and unique string identifying the group.
-
#name ⇒ String
(also: #group_name)
-
#path ⇒ String
The path to the group.
Actions collapse
-
#add_user(options = {}) ⇒ EmptyStructure
-
#attach_policy(options = {}) ⇒ EmptyStructure
-
#create(options = {}) ⇒ Group
-
#create_policy(options = {}) ⇒ GroupPolicy
-
#delete(options = {}) ⇒ EmptyStructure
-
#detach_policy(options = {}) ⇒ EmptyStructure
-
#remove_user(options = {}) ⇒ EmptyStructure
-
#update(options = {}) ⇒ Group
Associations collapse
-
#attached_policies(options = {}) ⇒ Policy::Collection
-
#policies(options = {}) ⇒ GroupPolicy::Collection
-
#policy(name) ⇒ GroupPolicy
-
#users(options = {}) ⇒ User::Collection
Instance Method Summary collapse
-
#client ⇒ Client
-
#data ⇒ Types::Group
Returns the data for this Group.
-
#data_loaded? ⇒ Boolean
Returns
true
if this resource is loaded. -
#initialize(*args) ⇒ Group
constructor
A new instance of Group.
- #load ⇒ self (also: #reload)
-
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::IAM::Client] #wait_until instead
Constructor Details
#initialize(name, options = {}) ⇒ Group #initialize(options = {}) ⇒ Group
Returns a new instance of Group.
22 23 24 25 26 27 28 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 22 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @name = extract_name(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#add_user(options = {}) ⇒ EmptyStructure
240 241 242 243 244 245 246 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 240 def add_user( = {}) = .merge(group_name: @name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.add_user_to_group() end resp.data end |
#arn ⇒ String
The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide.
69 70 71 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 69 def arn data[:arn] end |
#attach_policy(options = {}) ⇒ EmptyStructure
264 265 266 267 268 269 270 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 264 def attach_policy( = {}) = .merge(group_name: @name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.attach_group_policy() end resp.data end |
#attached_policies(options = {}) ⇒ Policy::Collection
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 490 def attached_policies( = {}) batches = Enumerator.new do |y| = .merge(group_name: @name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.list_attached_group_policies() end resp.each_page do |page| batch = [] page.data.attached_policies.each do |a| batch << Policy.new( arn: a.policy_arn, client: @client ) end y.yield(batch) end end Policy::Collection.new(batches) end |
#client ⇒ Client
87 88 89 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 87 def client @client end |
#create(options = {}) ⇒ Group
297 298 299 300 301 302 303 304 305 306 307 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 297 def create( = {}) = .merge(group_name: @name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.create_group() end Group.new( name: [:group_name], data: resp.data.group, client: @client ) end |
#create_date ⇒ Time
The date and time, in ISO 8601 date-time format, when the group was created.
80 81 82 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 80 def create_date data[:create_date] end |
#create_policy(options = {}) ⇒ GroupPolicy
351 352 353 354 355 356 357 358 359 360 361 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 351 def create_policy( = {}) = .merge(group_name: @name) Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.put_group_policy() end GroupPolicy.new( group_name: @name, name: [:policy_name], client: @client ) end |
#data ⇒ Types::Group
Returns the data for this Aws::IAM::Group. Calls
Client#get_group if #data_loaded? is false
.
109 110 111 112 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 109 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
117 118 119 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 117 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
368 369 370 371 372 373 374 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 368 def delete( = {}) = .merge(group_name: @name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.delete_group() end resp.data end |
#detach_policy(options = {}) ⇒ EmptyStructure
392 393 394 395 396 397 398 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 392 def detach_policy( = {}) = .merge(group_name: @name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.detach_group_policy() end resp.data end |
#group_id ⇒ String
The stable and unique string identifying the group. For more information about IDs, see IAM identifiers in the IAM User Guide.
57 58 59 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 57 def group_id data[:group_id] end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::IAM::Group.
Returns self
making it possible to chain methods.
group.reload.data
97 98 99 100 101 102 103 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 97 def load resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.get_group(group_name: @name) end @data = resp.group self end |
#name ⇒ String Also known as: group_name
33 34 35 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 33 def name @name end |
#path ⇒ String
The path to the group. For more information about paths, see IAM identifiers in the IAM User Guide.
45 46 47 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 45 def path data[:path] end |
#policies(options = {}) ⇒ GroupPolicy::Collection
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 515 def policies( = {}) batches = Enumerator.new do |y| = .merge(group_name: @name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.list_group_policies() end resp.each_page do |page| batch = [] page.data.policy_names.each do |p| batch << GroupPolicy.new( group_name: @name, name: p, client: @client ) end y.yield(batch) end end GroupPolicy::Collection.new(batches) end |
#policy(name) ⇒ GroupPolicy
538 539 540 541 542 543 544 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 538 def policy(name) GroupPolicy.new( group_name: @name, name: name, client: @client ) end |
#remove_user(options = {}) ⇒ EmptyStructure
418 419 420 421 422 423 424 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 418 def remove_user( = {}) = .merge(group_name: @name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.remove_user_from_group() end resp.data end |
#update(options = {}) ⇒ Group
455 456 457 458 459 460 461 462 463 464 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 455 def update( = {}) = .merge(group_name: @name) Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.update_group() end Group.new( name: [:new_group_name], client: @client ) end |
#users(options = {}) ⇒ User::Collection
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 551 def users( = {}) batches = Enumerator.new do |y| = .merge(group_name: @name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.get_group() end resp.each_page do |page| batch = [] page.data.users.each do |u| batch << User.new( name: u.user_name, data: u, client: @client ) end y.yield(batch) end end User::Collection.new(batches) end |
#wait_until(options = {}) {|resource| ... } ⇒ Resource
Use [Aws::IAM::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) do |instance|
instance.state.name == 'running'
end
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
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 201 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::Plugins::UserAgent.metric('RESOURCE_MODEL') do Aws::Waiters::Waiter.new().wait({}) end end |