class Aws::IAM::PolicyVersion
Public Class Methods
@overload def initialize(arn, version_id
, options = {})
@param [String] arn @param [String] version_id @option options [Client] :client
@overload def initialize(options = {})
@option options [required, String] :arn @option options [required, String] :version_id @option options [Client] :client
# File lib/aws-sdk-iam/policy_version.rb, line 24 def initialize(*args) options = Hash === args.last ? args.pop.dup : {} @arn = extract_arn(args, options) @version_id = extract_version_id(args, options) @data = options.delete(:data) @client = options.delete(:client) || Client.new(options) @waiter_block_warned = false end
Public Instance Methods
@return [String]
# File lib/aws-sdk-iam/policy_version.rb, line 36 def arn @arn end
@return [Client]
# File lib/aws-sdk-iam/policy_version.rb, line 88 def client @client end
The date and time, in [ISO 8601 date-time format], when the policy version was created.
[1]: www.iso.org/iso/iso8601 @return [Time]
# File lib/aws-sdk-iam/policy_version.rb, line 81 def create_date data[:create_date] end
@return [Types::PolicyVersion]
Returns the data for this {PolicyVersion}. Calls {Client#get_policy_version} if {#data_loaded?} is `false`.
# File lib/aws-sdk-iam/policy_version.rb, line 111 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/policy_version.rb, line 119 def data_loaded? !!@data end
@example Request syntax with placeholder values
policy_version.delete()
@param [Hash] options ({}) @return [EmptyStructure]
# File lib/aws-sdk-iam/policy_version.rb, line 227 def delete(options = {}) options = options.merge( policy_arn: @arn, version_id: @version_id ) resp = @client.delete_policy_version(options) resp.data end
The policy document.
The policy document is returned in the response to the GetPolicyVersion and GetAccountAuthorizationDetails operations. It is not returned in the response to the CreatePolicyVersion or ListPolicyVersions operations.
The policy document returned in this structure is URL-encoded compliant with [RFC 3986]. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the `decode` method of the `java.net.URLDecoder` utility class in the Java SDK. Other languages and SDKs provide similar functionality.
[1]: tools.ietf.org/html/rfc3986 @return [String]
# File lib/aws-sdk-iam/policy_version.rb, line 63 def document data[:document] end
@deprecated @api private
# File lib/aws-sdk-iam/policy_version.rb, line 252 def identifiers { arn: @arn, version_id: @version_id } end
Specifies whether the policy version is set as the policy's default version. @return [Boolean]
# File lib/aws-sdk-iam/policy_version.rb, line 70 def is_default_version data[:is_default_version] end
Loads, or reloads {#data} for the current {PolicyVersion}. Returns `self` making it possible to chain methods.
policy_version.reload.data
@return [self]
# File lib/aws-sdk-iam/policy_version.rb, line 98 def load resp = @client.get_policy_version( policy_arn: @arn, version_id: @version_id ) @data = resp.policy_version self end
@example Request syntax with placeholder values
policy_version.set_as_default()
@param [Hash] options ({}) @return [EmptyStructure]
# File lib/aws-sdk-iam/policy_version.rb, line 241 def set_as_default(options = {}) options = options.merge( policy_arn: @arn, version_id: @version_id ) resp = @client.set_default_policy_version(options) resp.data end
@return [String]
# File lib/aws-sdk-iam/policy_version.rb, line 41 def version_id @version_id 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/policy_version.rb, line 203 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/policy_version.rb, line 262 def extract_arn(args, options) value = args[0] || options.delete(:arn) case value when String then value when nil then raise ArgumentError, "missing required option :arn" else msg = "expected :arn to be a String, got #{value.class}" raise ArgumentError, msg end end
# File lib/aws-sdk-iam/policy_version.rb, line 273 def extract_version_id(args, options) value = args[1] || options.delete(:version_id) case value when String then value when nil then raise ArgumentError, "missing required option :version_id" else msg = "expected :version_id to be a String, got #{value.class}" raise ArgumentError, msg end end