class Aws::IAM::RolePolicy
Public Class Methods
@overload def initialize(role_name
, name, options = {})
@param [String] role_name @param [String] name @option options [Client] :client
@overload def initialize(options = {})
@option options [required, String] :role_name @option options [required, String] :name @option options [Client] :client
# File lib/aws-sdk-iam/role_policy.rb, line 24 def initialize(*args) options = Hash === args.last ? args.pop.dup : {} @role_name = extract_role_name(args, options) @name = extract_name(args, options) @data = options.delete(:data) @client = options.delete(:client) || Client.new(options) @waiter_block_warned = false end
Public Instance Methods
@return [Client]
# File lib/aws-sdk-iam/role_policy.rb, line 60 def client @client end
@return [Types::GetRolePolicyResponse]
Returns the data for this {RolePolicy}. Calls {Client#get_role_policy} if {#data_loaded?} is `false`.
# File lib/aws-sdk-iam/role_policy.rb, line 83 def data load unless @data @data end
@return [Boolean]
Returns `true` if this resource is loaded. Accessing attributes or {#data} on an unloaded resource will trigger a call to {#load}.
# File lib/aws-sdk-iam/role_policy.rb, line 91 def data_loaded? !!@data end
@example Request syntax with placeholder values
role_policy.delete()
@param [Hash] options ({}) @return [EmptyStructure]
# File lib/aws-sdk-iam/role_policy.rb, line 199 def delete(options = {}) options = options.merge( role_name: @role_name, policy_name: @name ) resp = @client.delete_role_policy(options) resp.data end
@deprecated @api private
# File lib/aws-sdk-iam/role_policy.rb, line 259 def identifiers { role_name: @role_name, name: @name } end
Loads, or reloads {#data} for the current {RolePolicy}. Returns `self` making it possible to chain methods.
role_policy.reload.data
@return [self]
# File lib/aws-sdk-iam/role_policy.rb, line 70 def load resp = @client.get_role_policy( role_name: @role_name, policy_name: @name ) @data = resp.data self end
@return [String]
# File lib/aws-sdk-iam/role_policy.rb, line 41 def name @name end
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
. @return [String]
# File lib/aws-sdk-iam/role_policy.rb, line 53 def policy_document data[:policy_document] end
@example Request syntax with placeholder values
role_policy.put({ policy_document: "policyDocumentType", # required })
@param [Hash] options ({}) @option options [required, String] :policy_document
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][1] 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]: http://wikipedia.org/wiki/regex
@return [EmptyStructure]
# File lib/aws-sdk-iam/role_policy.rb, line 238 def put(options = {}) options = options.merge( role_name: @role_name, policy_name: @name ) resp = @client.put_role_policy(options) resp.data end
@return [Role]
# File lib/aws-sdk-iam/role_policy.rb, line 250 def role Role.new( name: @role_name, client: @client ) end
@return [String]
# File lib/aws-sdk-iam/role_policy.rb, line 36 def role_name @role_name end
@deprecated Use [Aws::IAM::Client] wait_until
instead
Waiter polls an API operation until a resource enters a desired state.
@note The waiting operation is performed on a copy. The original resource
remains unchanged.
## 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
@yieldparam [Resource] resource to be used in the waiting condition.
@raise [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.
@raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
encountered while polling for a resource that is not expected.
@raise [NotImplementedError] Raised when the resource does not
@option options [Integer] :max_attempts (10) Maximum number of attempts @option options [Integer] :delay (10) Delay between each attempt in seconds @option options [Proc] :before_attempt (nil) Callback invoked before each attempt @option options [Proc] :before_wait (nil) Callback invoked before each wait @return [Resource] if the waiter was successful
# File lib/aws-sdk-iam/role_policy.rb, line 175 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
Private Instance Methods
# File lib/aws-sdk-iam/role_policy.rb, line 280 def extract_name(args, options) value = args[1] || options.delete(:name) case value when String then value when nil then raise ArgumentError, "missing required option :name" else msg = "expected :name to be a String, got #{value.class}" raise ArgumentError, msg end end
# File lib/aws-sdk-iam/role_policy.rb, line 269 def extract_role_name(args, options) value = args[0] || options.delete(:role_name) case value when String then value when nil then raise ArgumentError, "missing required option :role_name" else msg = "expected :role_name to be a String, got #{value.class}" raise ArgumentError, msg end end