Sha256: bd2f021c911093dd030a94dbf94ab782dba4a5d57c1d3e24026de105d1aea75a

Contents?: true

Size: 1.88 KB

Versions: 46

Compression:

Stored size: 1.88 KB

Contents

module Fog
  module AWS
    class STS
      class Real
        require 'fog/aws/parsers/sts/assume_role'

        # Assume Role
        #
        # ==== Parameters
        # * role_session_name<~String> - An identifier for the assumed role.
        # * role_arn<~String> - The ARN of the role the caller is assuming.
        # * external_id<~String> - An optional unique identifier required by the assuming role's trust identity.
        # * policy<~String> - An optional JSON policy document
        # * duration<~Integer> - Duration (of seconds) for the assumed role credentials to be valid (default 3600)
        #
        # ==== Returns
        # * response<~Excon::Response>:
        #   * body<~Hash>:
        #     * 'Arn'<~String>: The ARN of the assumed role/user
        #     * 'AccessKeyId'<~String>: The AWS access key of the temporary credentials for the assumed role
        #     * 'SecretAccessKey'<~String>: The AWS secret key of the temporary credentials for the assumed role
        #     * 'SessionToken'<~String>: The AWS session token of the temporary credentials for the assumed role
        #     * 'Expiration'<~Time>: The expiration time of the temporary credentials for the assumed role
        #
        # ==== See Also
        # http://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html
        #

        def assume_role(role_session_name, role_arn, external_id=nil, policy=nil, duration=3600)
          request({
            'Action'          => 'AssumeRole',
            'RoleSessionName' => role_session_name,
            'RoleArn'         => role_arn,
            'Policy'          => policy && Fog::JSON.encode(policy),
            'DurationSeconds' => duration,
            'ExternalId'      => external_id,
            :idempotent       => true,
            :parser           => Fog::Parsers::AWS::STS::AssumeRole.new
          })
        end
      end
    end
  end
end

Version data entries

46 entries across 46 versions & 5 rubygems

Version Path
fog-aws-0.12.0 lib/fog/aws/requests/sts/assume_role.rb
fog-aws-0.11.0 lib/fog/aws/requests/sts/assume_role.rb
fog-aws-0.10.0 lib/fog/aws/requests/sts/assume_role.rb
fog-aws-0.9.4 lib/fog/aws/requests/sts/assume_role.rb
fog-aws-0.9.3 lib/fog/aws/requests/sts/assume_role.rb
fog-aws-0.9.2 lib/fog/aws/requests/sts/assume_role.rb
fog-aws-0.9.1 lib/fog/aws/requests/sts/assume_role.rb
fog-aws-0.9.0 lib/fog/aws/requests/sts/assume_role.rb
fog-aws-0.8.1 lib/fog/aws/requests/sts/assume_role.rb
fog-aws-0.8.0 lib/fog/aws/requests/sts/assume_role.rb
vagrant-cloudstack-1.2.0 vendor/bundle/gems/fog-aws-0.7.5/lib/fog/aws/requests/sts/assume_role.rb
fog-aws-0.7.6 lib/fog/aws/requests/sts/assume_role.rb
fog-aws-0.7.5 lib/fog/aws/requests/sts/assume_role.rb
fog-aws-0.7.4 lib/fog/aws/requests/sts/assume_role.rb
fog-aws-0.7.3 lib/fog/aws/requests/sts/assume_role.rb
fog-aws-0.7.2 lib/fog/aws/requests/sts/assume_role.rb
fog-aws-0.6.0 lib/fog/aws/requests/sts/assume_role.rb
fog-aws-0.5.0 lib/fog/aws/requests/sts/assume_role.rb
fog-aws-0.4.1 lib/fog/aws/requests/sts/assume_role.rb
vagrant-cloudstack-1.1.0 vendor/bundle/gems/fog-1.22.1/lib/fog/aws/requests/sts/assume_role.rb