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

Class: Aws::AssumeRoleCredentials

Inherits:

Object

Object
Aws::AssumeRoleCredentials

show all

Includes:: CredentialProvider

Defined in:: aws-sdk-core/lib/aws-sdk-core/assume_role_credentials.rb

Overview

An auto-refreshing credential provider that works by assuming a role via STS::Client#assume_role .

role_credentials = Aws::AssumeRoleCredentials.new(
 client: Aws::STS::Client.new(...),
 role_arn: "linked::account::arn",
 role_session_name: "session-name"
)
ec2 = Aws::EC2::Client.new(credentials: role_credentials)

If you omit :client option, a new STS::Client object will be constructed.

Instance Attribute Summary collapse

#client ⇒ STS::Client readonly

Attributes included from CredentialProvider

#credentials

Instance Method Summary collapse

#initialize(options = {}) ⇒ AssumeRoleCredentials constructor
A new instance of AssumeRoleCredentials.

Methods included from CredentialProvider

#access_key_id , #secret_access_key , #session_token , #set?

Constructor Details

#initialize(options = {}) ⇒ `AssumeRoleCredentials`

Returns a new instance of AssumeRoleCredentials.

Parameters:

options (Hash) (defaults to: {}) —
a customizable set of options

Options Hash (options):

:role_arn (required, String)
:role_session_name (required, String)
:policy (String)
:duration_seconds (Integer)
:external_id (String)
:client (STS::Client )

# File 'aws-sdk-core/lib/aws-sdk-core/assume_role_credentials.rb', line 29
def initialize(options = {})
 client_opts = {}
 @assume_role_params = {}
 options.each_pair do |key, value|
 if self.class.assume_role_options.include?(key)
 @assume_role_params[key] = value
 else
 client_opts[key] = value
 end
 end
 @client = client_opts[:client] || STS ::Client .new (client_opts)
 super
end

Instance Attribute Details

#client ⇒ `STS::Client` (readonly)

Returns:

(STS::Client )

44
45
46

# File 'aws-sdk-core/lib/aws-sdk-core/assume_role_credentials.rb', line 44
def client
 @client
end