Class: Aws::STS::Types::AssumeRoleWithWebIdentityRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-sts/types.rb

Overview

Note:

When making an API call, you may pass AssumeRoleWithWebIdentityRequest data as a hash:

{
  role_arn: "arnType", # required
  role_session_name: "roleSessionNameType", # required
  web_identity_token: "clientTokenType", # required
  provider_id: "urlType",
  policy: "sessionPolicyDocumentType",
  duration_seconds: 1,
}

See Also:

Instance Attribute Summary collapse

Method Summary

Methods included from Aws::Structure

#empty?, included, #initialize, #key?, new, #to_h, #to_s

Instance Attribute Details

#duration_seconds ⇒ Integer

The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting, the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see [View the Maximum Session Duration Setting for a Role] in the *IAM User Guide*.

By default, the value is set to 3600 seconds.

<note markdown=“1”> The ‘DurationSeconds` parameter is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a `SessionDuration` parameter that specifies the maximum length of the console session. For more information, see [Creating a URL that Enables Federated Users to Access the AWS Management Console] in the *IAM User Guide*.

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session [2]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html

Returns:

  • (Integer) 


515
516
517
518
519
520
521
522
523
 
# File 'lib/aws-sdk-sts/types.rb', line 515

class AssumeRoleWithWebIdentityRequest < Struct.new(
  :role_arn,
  :role_session_name,
  :web_identity_token,
  :provider_id,
  :policy,
  :duration_seconds)
  include Aws::Structure
end

#policy ⇒ String

An IAM policy in JSON format.

The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see [Permissions for AssumeRoleWithWebIdentity] in the *IAM User Guide*.

The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\u0020-\u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters.

<note markdown=“1”> The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html

Returns:

  • (String) 


515
516
517
518
519
520
521
522
523
 
# File 'lib/aws-sdk-sts/types.rb', line 515

class AssumeRoleWithWebIdentityRequest < Struct.new(
  :role_arn,
  :role_session_name,
  :web_identity_token,
  :provider_id,
  :policy,
  :duration_seconds)
  include Aws::Structure
end

#provider_id ⇒ String

The fully qualified host component of the domain name of the identity provider.

Specify this value only for OAuth 2.0 access tokens. Currently ‘www.amazon.com` and `graph.facebook.com` are the only supported identity providers for OAuth 2.0 access tokens. Do not include URL schemes and port numbers.

Do not specify this value for OpenID Connect ID tokens.

Returns:

  • (String) 


515
516
517
518
519
520
521
522
523
 
# File 'lib/aws-sdk-sts/types.rb', line 515

class AssumeRoleWithWebIdentityRequest < Struct.new(
  :role_arn,
  :role_session_name,
  :web_identity_token,
  :provider_id,
  :policy,
  :duration_seconds)
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the role that the caller is assuming.

Returns:

  • (String) 


515
516
517
518
519
520
521
522
523
 
# File 'lib/aws-sdk-sts/types.rb', line 515

class AssumeRoleWithWebIdentityRequest < Struct.new(
  :role_arn,
  :role_session_name,
  :web_identity_token,
  :provider_id,
  :policy,
  :duration_seconds)
  include Aws::Structure
end

#role_session_name ⇒ String

An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the ‘AssumedRoleUser` response element.

The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-

Returns:

  • (String) 


515
516
517
518
519
520
521
522
523
 
# File 'lib/aws-sdk-sts/types.rb', line 515

class AssumeRoleWithWebIdentityRequest < Struct.new(
  :role_arn,
  :role_session_name,
  :web_identity_token,
  :provider_id,
  :policy,
  :duration_seconds)
  include Aws::Structure
end

#web_identity_token ⇒ String

The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an ‘AssumeRoleWithWebIdentity` call.

Returns:

  • (String) 


515
516
517
518
519
520
521
522
523
 
# File 'lib/aws-sdk-sts/types.rb', line 515

class AssumeRoleWithWebIdentityRequest < Struct.new(
  :role_arn,
  :role_session_name,
  :web_identity_token,
  :provider_id,
  :policy,
  :duration_seconds)
  include Aws::Structure
end