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:



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

def client
  @client
end

#create_dateTime

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

Returns:

  • (Time)


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

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:



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

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.



104
105
106
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/policy_version.rb', line 104

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


policy_version.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure)


115
116
117
118
119
120
121
122
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/policy_version.rb', line 115

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.

Returns:

  • (String)


48
49
50
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/policy_version.rb', line 48

def document
  data.document
end

#is_default_versionBoolean

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

Returns:

  • (Boolean)


55
56
57
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/policy_version.rb', line 55

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)


83
84
85
86
87
88
89
90
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/policy_version.rb', line 83

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)


129
130
131
132
133
134
135
136
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/policy_version.rb', line 129

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