Class: Aws::IAM::GroupPolicy

Inherits:
Object
  • Object
show all
Extended by:
Deprecations
Defined in:
lib/aws-sdk-iam/group_policy.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(group_name, name, options = {}) ⇒ GroupPolicy #initialize(options = {}) ⇒ GroupPolicy

Returns a new instance of GroupPolicy.

Overloads:

  • #initialize(group_name, name, options = {}) ⇒ GroupPolicy

    Parameters:

    • group_name (String)
    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ GroupPolicy

    Options Hash (options):

    • :group_name (required, String)
    • :name (required, String)
    • :client (Client) 


21
22
23
24
25
26
27
 
# File 'lib/aws-sdk-iam/group_policy.rb', line 21

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

Instance Method Details

#client ⇒ Client

Returns:



51
52
53
 
# File 'lib/aws-sdk-iam/group_policy.rb', line 51

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`.

Returns:



74
75
76
77
 
# File 'lib/aws-sdk-iam/group_policy.rb', line 74

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.



82
83
84
 
# File 'lib/aws-sdk-iam/group_policy.rb', line 82

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


group_policy.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure) 


188
189
190
191
192
193
194
195
 
# File 'lib/aws-sdk-iam/group_policy.rb', line 188

def delete(options = {})
  options = options.merge(
    group_name: @group_name,
    policy_name: @name
  )
  resp = @client.delete_group_policy(options)
  resp.data
end

#group ⇒ Group

Returns:



234
235
236
237
238
239
 
# File 'lib/aws-sdk-iam/group_policy.rb', line 234

def group
  Group.new(
    name: @group_name,
    client: @client
  )
end

#group_name ⇒ String

Returns:

  • (String) 


32
33
34
 
# File 'lib/aws-sdk-iam/group_policy.rb', line 32

def group_name
  @group_name
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.

Deprecated. 


243
244
245
246
247
248
 
# File 'lib/aws-sdk-iam/group_policy.rb', line 243

def identifiers
  {
    group_name: @group_name,
    name: @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

Returns:

  • (self) 


61
62
63
64
65
66
67
68
 
# File 'lib/aws-sdk-iam/group_policy.rb', line 61

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

Returns:

  • (String) 


37
38
39
 
# File 'lib/aws-sdk-iam/group_policy.rb', line 37

def name
  @name
end

#policy_document ⇒ String

The policy document.

Returns:

  • (String) 


44
45
46
 
# File 'lib/aws-sdk-iam/group_policy.rb', line 44

def policy_document
  data[:policy_document]
end

#put(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


group_policy.put({
  policy_document: "policyDocumentType", # required
})

Parameters:

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

    ({})

Options Hash (options):

  • :policy_document (required, String) —

    The policy document.

    The [regex pattern] used to validate this parameter is a string of characters consisting of the following:

    • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

    • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

    • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

    [1]: wikipedia.org/wiki/regex

Returns:

  • (EmptyStructure) 


222
223
224
225
226
227
228
229
 
# File 'lib/aws-sdk-iam/group_policy.rb', line 222

def put(options = {})
  options = options.merge(
    group_name: @group_name,
    policy_name: @name
  )
  resp = @client.put_group_policy(options)
  resp.data
end

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

Deprecated.

Use [Aws::IAM::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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/aws-sdk-iam/group_policy.rb', line 164

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