Class: Aws::IAM::PolicyVersion

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Instance Method Summary collapse

Constructor Details

#initialize(arn, version_id, options = {}) ⇒ PolicyVersion #initialize(options = {}) ⇒ PolicyVersion

Returns a new instance of PolicyVersion.

Overloads:

  • #initialize(arn, version_id, options = {}) ⇒ PolicyVersion

    Parameters:

    • arn (String)
    • version_id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ PolicyVersion

    Options Hash (options):

    • :arn (required, String)
    • :version_id (required, String)
    • :client (Client) 


22
23
24
25
26
27
28
29
 
# File 'lib/aws-sdk-iam/policy_version.rb', line 22

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

Instance Method Details

#arn ⇒ String

Returns:

  • (String) 


34
35
36
 
# File 'lib/aws-sdk-iam/policy_version.rb', line 34

def arn
  @arn
end

#client ⇒ Client

Returns:



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

def client
  @client
end

#create_date ⇒ Time

The date and time, in [ISO 8601 date-time format], when the policy version was created.

[1]: www.iso.org/iso/iso8601

Returns:

  • (Time) 


79
80
81
 
# File 'lib/aws-sdk-iam/policy_version.rb', line 79

def create_date
  data[:create_date]
end

#data ⇒ Types::PolicyVersion

Returns the data for this Aws::IAM::PolicyVersion. Calls Client#get_policy_version if #data_loaded? is ‘false`.

Returns:



109
110
111
112
 
# File 'lib/aws-sdk-iam/policy_version.rb', line 109

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.



117
118
119
 
# File 'lib/aws-sdk-iam/policy_version.rb', line 117

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


policy_version.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure) 


225
226
227
228
229
230
231
232
 
# File 'lib/aws-sdk-iam/policy_version.rb', line 225

def delete(options = {})
  options = options.merge(
    policy_arn: @arn,
    version_id: @version_id
  )
  resp = @client.delete_policy_version(options)
  resp.data
end

#document ⇒ String

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

Returns:

  • (String) 


61
62
63
 
# File 'lib/aws-sdk-iam/policy_version.rb', line 61

def document
  data[:document]
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. 


250
251
252
253
254
255
 
# File 'lib/aws-sdk-iam/policy_version.rb', line 250

def identifiers
  {
    arn: @arn,
    version_id: @version_id
  }
end

#is_default_version ⇒ Boolean

Specifies whether the policy version is set as the policy’s default version.

Returns:

  • (Boolean) 


68
69
70
 
# File 'lib/aws-sdk-iam/policy_version.rb', line 68

def is_default_version
  data[:is_default_version]
end

#load ⇒ self Also known as: reload

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

policy_version.reload.data

Returns:

  • (self) 


96
97
98
99
100
101
102
103
 
# File 'lib/aws-sdk-iam/policy_version.rb', line 96

def load
  resp = @client.get_policy_version(
    policy_arn: @arn,
    version_id: @version_id
  )
  @data = resp.policy_version
  self
end

#set_as_default(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


policy_version.set_as_default()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure) 


239
240
241
242
243
244
245
246
 
# File 'lib/aws-sdk-iam/policy_version.rb', line 239

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

#version_id ⇒ String

Returns:

  • (String) 


39
40
41
 
# File 'lib/aws-sdk-iam/policy_version.rb', line 39

def version_id
  @version_id
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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/aws-sdk-iam/policy_version.rb', line 201

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