Class: AWS::STS::FederatedSession

Inherits:
Session
  • Object
show all
Defined in:
lib/aws/sts/federated_session.rb

Overview

Represents a federated session using temporary AWS credentials. Use #new_federated_session to get an instance of this class.

Instance Attribute Summary collapse

Attributes inherited from Session

#credentials, #expires_at

Instance Method Summary collapse

Constructor Details

#initialize(opts = {}) ⇒ FederatedSession

Returns a new instance of FederatedSession.


46
47
48
49
50
51
# File 'lib/aws/sts/federated_session.rb', line 46

def initialize(opts = {})
  @user_id = opts[:user_id]
  @user_arn = opts[:user_arn]
  @packed_policy_size = opts[:packed_policy_size]
  super
end

Instance Attribute Details

#packed_policy_sizeInteger (readonly)

A percentage value indicating the size of the policy in packed form. Policies for which the packed size is greater than 100% of the allowed value are rejected by the service.

Returns:

  • (Integer)

43
44
45
# File 'lib/aws/sts/federated_session.rb', line 43

def packed_policy_size
  @packed_policy_size
end

#user_arnString (readonly)

The ARN specifying the federated user associated with the session. For more information about ARNs and how to use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

Returns:

  • (String)

36
37
38
# File 'lib/aws/sts/federated_session.rb', line 36

def user_arn
  @user_arn
end

#user_idString (readonly)

The string identifying the federated user associated with the session, similar to the UserId of an IAM user.

Returns:

  • (String)

26
27
28
# File 'lib/aws/sts/federated_session.rb', line 26

def user_id
  @user_id
end