You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::IAM::PolicyVersion

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

Defined Under Namespace

Classes: Collection

Actions collapse

Read-Only Attributes 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)


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

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)
end

Instance Method Details

#arnString

Returns:

  • (String)


32
33
34
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/policy_version.rb', line 32

def arn
  @arn
end

#clientClient

Returns:



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

def client
  @client
end

#create_dateTime

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

Returns:

  • (Time)


77
78
79
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/policy_version.rb', line 77

def create_date
  data[:create_date]
end

#dataTypes::PolicyVersion

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

Returns:



107
108
109
110
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/policy_version.rb', line 107

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.



115
116
117
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/policy_version.rb', line 115

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


policy_version.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure)


221
222
223
224
225
226
227
228
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/policy_version.rb', line 221

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

#documentString

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.

Returns:

  • (String)


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

def document
  data[:document]
end

#is_default_versionBoolean

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

Returns:

  • (Boolean)


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

def is_default_version
  data[:is_default_version]
end

#loadself 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)


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

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)


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

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_idString

Returns:

  • (String)


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

def version_id
  @version_id
end

#wait_until(options = {}, &block) ⇒ 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) {|instance| instance.state.name == 'running' }

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

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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/policy_version.rb', line 197

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