Class: Aws::STS::Types::AssumeRoleWithWebIdentityRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::STS::Types::AssumeRoleWithWebIdentityRequest
- Defined in:
- gems/aws-sdk-core/lib/aws-sdk-sts/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:web_identity_token]
Instance Attribute Summary collapse
-
#duration_seconds ⇒ Integer
The duration, in seconds, of the role session.
-
#policy ⇒ String
An IAM policy in JSON format that you want to use as an inline session policy.
-
#policy_arns ⇒ Array<Types::PolicyDescriptorType>
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies.
-
#provider_id ⇒ String
The fully qualified host component of the domain name of the OAuth 2.0 identity provider.
-
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the role that the caller is assuming.
-
#role_session_name ⇒ String
An identifier for the assumed role session.
-
#web_identity_token ⇒ String
The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider.
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.
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 Amazon
Web Services Management Console in the IAM User Guide.
790 791 792 793 794 795 796 797 798 799 800 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 790 class AssumeRoleWithWebIdentityRequest < Struct.new( :role_arn, :role_session_name, :web_identity_token, :provider_id, :policy_arns, :policy, :duration_seconds) SENSITIVE = [:web_identity_token] include Aws::Structure end |
#policy ⇒ String
An IAM policy in JSON format that you want to use as an inline session policy.
This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\u0020 through \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters.
PackedPolicySize
response element indicates by percentage how
close the policies and tags for your request are to the upper size
limit.
790 791 792 793 794 795 796 797 798 799 800 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 790 class AssumeRoleWithWebIdentityRequest < Struct.new( :role_arn, :role_session_name, :web_identity_token, :provider_id, :policy_arns, :policy, :duration_seconds) SENSITIVE = [:web_identity_token] include Aws::Structure end |
#policy_arns ⇒ Array<Types::PolicyDescriptorType>
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.
This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
PackedPolicySize
response element indicates by percentage how
close the policies and tags for your request are to the upper size
limit.
Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
790 791 792 793 794 795 796 797 798 799 800 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 790 class AssumeRoleWithWebIdentityRequest < Struct.new( :role_arn, :role_session_name, :web_identity_token, :provider_id, :policy_arns, :policy, :duration_seconds) SENSITIVE = [:web_identity_token] include Aws::Structure end |
#provider_id ⇒ String
The fully qualified host component of the domain name of the OAuth 2.0 identity provider. Do not specify this value for an OpenID Connect identity provider.
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.
790 791 792 793 794 795 796 797 798 799 800 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 790 class AssumeRoleWithWebIdentityRequest < Struct.new( :role_arn, :role_session_name, :web_identity_token, :provider_id, :policy_arns, :policy, :duration_seconds) SENSITIVE = [:web_identity_token] include Aws::Structure end |
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the role that the caller is assuming.
790 791 792 793 794 795 796 797 798 799 800 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 790 class AssumeRoleWithWebIdentityRequest < Struct.new( :role_arn, :role_session_name, :web_identity_token, :provider_id, :policy_arns, :policy, :duration_seconds) SENSITIVE = [:web_identity_token] 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: =,.@-
790 791 792 793 794 795 796 797 798 799 800 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 790 class AssumeRoleWithWebIdentityRequest < Struct.new( :role_arn, :role_session_name, :web_identity_token, :provider_id, :policy_arns, :policy, :duration_seconds) SENSITIVE = [:web_identity_token] 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. Only tokens with RSA algorithms
(RS256) are supported.
790 791 792 793 794 795 796 797 798 799 800 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 790 class AssumeRoleWithWebIdentityRequest < Struct.new( :role_arn, :role_session_name, :web_identity_token, :provider_id, :policy_arns, :policy, :duration_seconds) SENSITIVE = [:web_identity_token] include Aws::Structure end |