Class: Aws::IAM::UserPolicy

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-iam/lib/aws-sdk-iam/user_policy.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(user_name, name, options = {}) ⇒ UserPolicy #initialize(options = {}) ⇒ UserPolicy

Returns a new instance of UserPolicy.

Overloads:

  • #initialize(user_name, name, options = {}) ⇒ UserPolicy

    Parameters:

    • user_name (String)
    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ UserPolicy

    Options Hash (options):

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


24
25
26
27
28
29
30
31
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user_policy.rb', line 24

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

Instance Method Details

#client ⇒ Client

Returns:



60
61
62
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user_policy.rb', line 60

def client
  @client
end

#data ⇒ Types::GetUserPolicyResponse

Returns the data for this Aws::IAM::UserPolicy. Calls Client#get_user_policy if #data_loaded? is false.

Returns:



85
86
87
88
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user_policy.rb', line 85

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.



93
94
95
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user_policy.rb', line 93

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


user_policy.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure) 


203
204
205
206
207
208
209
210
211
212
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user_policy.rb', line 203

def delete(options = {})
  options = options.merge(
    user_name: @user_name,
    policy_name: @name
  )
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.delete_user_policy(options)
  end
  resp.data
end

#load ⇒ self Also known as: reload

Loads, or reloads #data for the current Aws::IAM::UserPolicy. Returns self making it possible to chain methods.

user_policy.reload.data

Returns:

  • (self) 


70
71
72
73
74
75
76
77
78
79
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user_policy.rb', line 70

def load
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.get_user_policy(
    user_name: @user_name,
    policy_name: @name
  )
  end
  @data = resp.data
  self
end

#name ⇒ String Also known as: policy_name

Returns:

  • (String) 


41
42
43
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user_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.

Returns:

  • (String) 


53
54
55
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user_policy.rb', line 53

def policy_document
  data[:policy_document]
end

#put(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (options):

  • :policy_document (required, String) —

    The policy document.

    You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

    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)

Returns:

  • (EmptyStructure) 


244
245
246
247
248
249
250
251
252
253
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user_policy.rb', line 244

def put(options = {})
  options = options.merge(
    user_name: @user_name,
    policy_name: @name
  )
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.put_user_policy(options)
  end
  resp.data
end

#user ⇒ User

Returns:



258
259
260
261
262
263
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user_policy.rb', line 258

def user
  User.new(
    name: @user_name,
    client: @client
  )
end

#user_name ⇒ String

Returns:

  • (String) 


36
37
38
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user_policy.rb', line 36

def user_name
  @user_name
end

#wait_until(options = {}) {|resource| ... } ⇒ 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) 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

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

Yield Parameters:

  • resource (Resource) —

    to be used in the waiting condition.

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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user_policy.rb', line 177

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::Plugins::UserAgent.feature('resource') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end