Class: Aws::IAM::AssumeRolePolicy

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(role_name, options = {}) ⇒ AssumeRolePolicy #initialize(options = {}) ⇒ AssumeRolePolicy

Returns a new instance of AssumeRolePolicy.

Overloads:

  • #initialize(role_name, options = {}) ⇒ AssumeRolePolicy

    Parameters:

    • role_name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ AssumeRolePolicy

    Options Hash (options):

    • :role_name (required, String)
    • :client (Client) 


19
20
21
22
23
24
 
# File 'lib/aws-sdk-iam/assume_role_policy.rb', line 19

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @role_name = extract_role_name(args, options)
  @data = Aws::EmptyStructure.new
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#client ⇒ Client

Returns:



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

def client
  @client
end

#data ⇒ EmptyStructure

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.

Returns:

  • (EmptyStructure) 


50
51
52
 
# File 'lib/aws-sdk-iam/assume_role_policy.rb', line 50

def 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.



57
58
59
 
# File 'lib/aws-sdk-iam/assume_role_policy.rb', line 57

def data_loaded?
  !!@data
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. 


102
103
104
 
# File 'lib/aws-sdk-iam/assume_role_policy.rb', line 102

def identifiers
  { role_name: @role_name }
end

#load ⇒ Object Also known as: reload

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.

Raises:

  • (NotImplementedError) 


42
43
44
45
 
# File 'lib/aws-sdk-iam/assume_role_policy.rb', line 42

def load
  msg = "#load is not implemented, data only available via enumeration"
  raise NotImplementedError, msg
end

#role ⇒ Role

Returns:



93
94
95
96
97
98
 
# File 'lib/aws-sdk-iam/assume_role_policy.rb', line 93

def role
  Role.new(
    name: @role_name,
    client: @client
  )
end

#role_name ⇒ String

Returns:

  • (String) 


29
30
31
 
# File 'lib/aws-sdk-iam/assume_role_policy.rb', line 29

def role_name
  @role_name
end

#update(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


assume_role_policy.update({
  policy_document: "policyDocumentType", # required
})

Parameters:

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

    ({})

Options Hash (options):

  • :policy_document (required, String) —

    The policy that grants an entity permission to assume the role.

    The [regex pattern] used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF). It also includes the special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D).

    [1]: wikipedia.org/wiki/regex

Returns:

  • (EmptyStructure) 


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

def update(options = {})
  options = options.merge(role_name: @role_name)
  resp = @client.update_assume_role_policy(options)
  resp.data
end