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

Class: Aws::IAM::AssumeRolePolicy

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

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes 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 'gems/aws-sdk-iam/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

#clientClient

Returns:



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

def client
  @client
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 'gems/aws-sdk-iam/lib/aws-sdk-iam/assume_role_policy.rb', line 57

def data_loaded?
  !!@data
end

#roleRole

Returns:



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

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

#role_nameString

Returns:

  • (String)


29
30
31
# File 'gems/aws-sdk-iam/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).

Returns:

  • (EmptyStructure)


84
85
86
87
88
# File 'gems/aws-sdk-iam/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