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) 


24
25
26
27
28
29
30
31
 
# 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

Instance Method Details

#arn ⇒ String

Returns:

  • (String) 


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

def arn
  @arn
end

#client ⇒ Client

Returns:



92
93
94
 
# File 'lib/aws-sdk-iam/policy_version.rb', line 92

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) 


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

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:



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

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.



125
126
127
 
# File 'lib/aws-sdk-iam/policy_version.rb', line 125

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


policy_version.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure) 


235
236
237
238
239
240
241
242
243
244
 
# File 'lib/aws-sdk-iam/policy_version.rb', line 235

def delete(options = {})
  options = options.merge(
    policy_arn: @arn,
    version_id: @version_id
  )
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.delete_policy_version(options)
  end
  resp.data
end

#document ⇒ String

The policy document.

The policy document is returned in the response to the

GetPolicyVersion][1

and [GetAccountAuthorizationDetails]

operations. It is not returned in the response to the

CreatePolicyVersion][3

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]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetPolicyVersion.html [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetAccountAuthorizationDetails.html [3]: docs.aws.amazon.com/IAM/latest/APIReference/API_CreatePolicyVersion.html [4]: docs.aws.amazon.com/IAM/latest/APIReference/API_ListPolicyVersions.html [5]: tools.ietf.org/html/rfc3986

Returns:

  • (String) 


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

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. 


264
265
266
267
268
269
 
# File 'lib/aws-sdk-iam/policy_version.rb', line 264

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) 


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

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) 


102
103
104
105
106
107
108
109
110
111
 
# File 'lib/aws-sdk-iam/policy_version.rb', line 102

def load
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.get_policy_version(
    policy_arn: @arn,
    version_id: @version_id
  )
  end
  @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) 


251
252
253
254
255
256
257
258
259
260
 
# File 'lib/aws-sdk-iam/policy_version.rb', line 251

def set_as_default(options = {})
  options = options.merge(
    policy_arn: @arn,
    version_id: @version_id
  )
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.set_default_policy_version(options)
  end
  resp.data
end

#version_id ⇒ String

Returns:

  • (String) 


41
42
43
 
# File 'lib/aws-sdk-iam/policy_version.rb', line 41

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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/aws-sdk-iam/policy_version.rb', line 209

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.metric('RESOURCE_MODEL') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end