Class: Aws::IAM::GroupPolicy
- Inherits:
-
Object
- Object
- Aws::IAM::GroupPolicy
- Defined in:
- gems/aws-sdk-iam/lib/aws-sdk-iam/group_policy.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#group_name ⇒ String
-
#name ⇒ String
(also: #policy_name)
-
#policy_document ⇒ String
The policy document.
Actions collapse
Associations collapse
Instance Method Summary collapse
-
#client ⇒ Client
-
#data ⇒ Types::GetGroupPolicyResponse
Returns the data for this GroupPolicy.
-
#data_loaded? ⇒ Boolean
Returns
true
if this resource is loaded. -
#initialize(*args) ⇒ GroupPolicy
constructor
A new instance of GroupPolicy.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current GroupPolicy.
-
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::IAM::Client] #wait_until instead
Constructor Details
#initialize(group_name, name, options = {}) ⇒ GroupPolicy #initialize(options = {}) ⇒ GroupPolicy
Returns a new instance of GroupPolicy.
24 25 26 27 28 29 30 31 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group_policy.rb', line 24 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @group_name = extract_group_name(args, ) @name = extract_name(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#client ⇒ Client
60 61 62 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group_policy.rb', line 60 def client @client end |
#data ⇒ Types::GetGroupPolicyResponse
Returns the data for this Aws::IAM::GroupPolicy. Calls
Client#get_group_policy if #data_loaded? is false
.
83 84 85 86 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group_policy.rb', line 83 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
91 92 93 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group_policy.rb', line 91 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
199 200 201 202 203 204 205 206 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group_policy.rb', line 199 def delete( = {}) = .merge( group_name: @group_name, policy_name: @name ) resp = @client.delete_group_policy() resp.data end |
#group ⇒ Group
250 251 252 253 254 255 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group_policy.rb', line 250 def group Group.new( name: @group_name, client: @client ) end |
#group_name ⇒ String
36 37 38 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group_policy.rb', line 36 def group_name @group_name end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::IAM::GroupPolicy.
Returns self
making it possible to chain methods.
group_policy.reload.data
70 71 72 73 74 75 76 77 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group_policy.rb', line 70 def load resp = @client.get_group_policy( group_name: @group_name, policy_name: @name ) @data = resp.data self end |
#name ⇒ String Also known as: policy_name
41 42 43 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group_policy.rb', line 41 def name @name end |
#policy_document ⇒ String
The policy document.
IAM stores policies in JSON format. However, resources that were created using CloudFormation templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
53 54 55 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group_policy.rb', line 53 def policy_document data[:policy_document] end |
#put(options = {}) ⇒ EmptyStructure
238 239 240 241 242 243 244 245 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group_policy.rb', line 238 def put( = {}) = .merge( group_name: @group_name, policy_name: @name ) resp = @client.put_group_policy() resp.data 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
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group_policy.rb', line 175 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 |