Interface AssumeRoleRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<AssumeRoleRequest.Builder,
,AssumeRoleRequest> SdkBuilder<AssumeRoleRequest.Builder,
,AssumeRoleRequest> SdkPojo
,SdkRequest.Builder
,StsRequest.Builder
- Enclosing class:
AssumeRoleRequest
-
Method Summary
Modifier and TypeMethodDescriptiondurationSeconds
(Integer durationSeconds) The duration, in seconds, of the role session.externalId
(String externalId) A unique identifier that might be required when you assume a role in another account.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.An IAM policy in JSON format that you want to use as an inline session policy.policyArns
(Collection<PolicyDescriptorType> policyArns) The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies.policyArns
(Consumer<PolicyDescriptorType.Builder>... policyArns) The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies.policyArns
(PolicyDescriptorType... policyArns) The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies.providedContexts
(Collection<ProvidedContext> providedContexts) A list of previously acquired trusted context assertions in the format of a JSON array.providedContexts
(Consumer<ProvidedContext.Builder>... providedContexts) A list of previously acquired trusted context assertions in the format of a JSON array.providedContexts
(ProvidedContext... providedContexts) A list of previously acquired trusted context assertions in the format of a JSON array.The Amazon Resource Name (ARN) of the role to assume.roleSessionName
(String roleSessionName) An identifier for the assumed role session.serialNumber
(String serialNumber) The identification number of the MFA device that is associated with the user who is making theAssumeRole
call.sourceIdentity
(String sourceIdentity) The source identity specified by the principal that is calling theAssumeRole
operation.tags
(Collection<Tag> tags) A list of session tags that you want to pass.tags
(Consumer<Tag.Builder>... tags) A list of session tags that you want to pass.A list of session tags that you want to pass.The value provided by the MFA device, if the trust policy of the role being assumed requires MFA.transitiveTagKeys
(String... transitiveTagKeys) A list of keys for session tags that you want to set as transitive.transitiveTagKeys
(Collection<String> transitiveTagKeys) A list of keys for session tags that you want to set as transitive.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.services.sts.model.StsRequest.Builder
build
-
Method Details
-
roleArn
The Amazon Resource Name (ARN) of the role to assume.
- Parameters:
roleArn
- The Amazon Resource Name (ARN) of the role to assume.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
roleSessionName
An identifier for the assumed role session.
Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal. This means that subsequent cross-account API requests that use the temporary security credentials will expose the role session name to the external account in their CloudTrail logs.
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: =,.@-
- Parameters:
roleSessionName
- An identifier for the assumed role session.Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal. This means that subsequent cross-account API requests that use the temporary security credentials will expose the role session name to the external account in their CloudTrail logs.
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:
- Returns a reference to this object so that method calls can be chained together.
-
policyArns
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.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The
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.
- Parameters:
policyArns
- 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.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
policyArns
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.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The
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.
- Parameters:
policyArns
- 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.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
policyArns
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.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The
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.
This is a convenience method that creates an instance of thePolicyDescriptorType.Builder
avoiding the need to create one manually viaPolicyDescriptorType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topolicyArns(List<PolicyDescriptorType>)
.- Parameters:
policyArns
- a consumer that will call methods onPolicyDescriptorType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
policy
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 ( through ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The
PackedPolicySize
response element indicates by percentage how close the policies and tags for your request are to the upper size limit.- Parameters:
policy
- 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 ( through ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The
PackedPolicySize
response element indicates by percentage how close the policies and tags for your request are to the upper size limit.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
durationSeconds
The duration, in seconds, of the role session. The value specified can range from 900 seconds (15 minutes) up to the maximum session duration set for the role. The maximum session duration setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting or the administrator setting (whichever is lower), 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.
Role chaining limits your Amazon Web Services CLI or Amazon Web Services API role session to a maximum of one hour. When you use the
AssumeRole
API operation to assume a role, you can specify the duration of your role session with theDurationSeconds
parameter. You can specify a parameter value of up to 43200 seconds (12 hours), depending on the maximum session duration setting for your role. However, if you assume a role using role chaining and provide aDurationSeconds
parameter value greater than one hour, the 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.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 aSessionDuration
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.- Parameters:
durationSeconds
- The duration, in seconds, of the role session. The value specified can range from 900 seconds (15 minutes) up to the maximum session duration set for the role. The maximum session duration setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting or the administrator setting (whichever is lower), 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.Role chaining limits your Amazon Web Services CLI or Amazon Web Services API role session to a maximum of one hour. When you use the
AssumeRole
API operation to assume a role, you can specify the duration of your role session with theDurationSeconds
parameter. You can specify a parameter value of up to 43200 seconds (12 hours), depending on the maximum session duration setting for your role. However, if you assume a role using role chaining and provide aDurationSeconds
parameter value greater than one hour, the 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.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 aSessionDuration
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of session tags that you want to pass. Each session tag consists of a key name and an associated value. For more information about session tags, see Tagging Amazon Web Services STS Sessions in the IAM User Guide.
This parameter is optional. You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters, and the values can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The
PackedPolicySize
response element indicates by percentage how close the policies and tags for your request are to the upper size limit.You can pass a session tag with the same key as a tag that is already attached to the role. When you do, session tags override a role tag with the same key.
Tag key–value pairs are not case sensitive, but case is preserved. This means that you cannot have separate
Department
anddepartment
tag keys. Assume that the role has theDepartment
=Marketing
tag and you pass thedepartment
=engineering
session tag.Department
anddepartment
are not saved as separate tags, and the session tag passed in the request takes precedence over the role tag.Additionally, if you used temporary credentials to perform this operation, the new session inherits any transitive session tags from the calling session. If you pass a session tag with the same key as an inherited tag, the operation fails. To view the inherited tags for a session, see the CloudTrail logs. For more information, see Viewing Session Tags in CloudTrail in the IAM User Guide.
- Parameters:
tags
- A list of session tags that you want to pass. Each session tag consists of a key name and an associated value. For more information about session tags, see Tagging Amazon Web Services STS Sessions in the IAM User Guide.This parameter is optional. You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters, and the values can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The
PackedPolicySize
response element indicates by percentage how close the policies and tags for your request are to the upper size limit.You can pass a session tag with the same key as a tag that is already attached to the role. When you do, session tags override a role tag with the same key.
Tag key–value pairs are not case sensitive, but case is preserved. This means that you cannot have separate
Department
anddepartment
tag keys. Assume that the role has theDepartment
=Marketing
tag and you pass thedepartment
=engineering
session tag.Department
anddepartment
are not saved as separate tags, and the session tag passed in the request takes precedence over the role tag.Additionally, if you used temporary credentials to perform this operation, the new session inherits any transitive session tags from the calling session. If you pass a session tag with the same key as an inherited tag, the operation fails. To view the inherited tags for a session, see the CloudTrail logs. For more information, see Viewing Session Tags in CloudTrail in the IAM User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of session tags that you want to pass. Each session tag consists of a key name and an associated value. For more information about session tags, see Tagging Amazon Web Services STS Sessions in the IAM User Guide.
This parameter is optional. You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters, and the values can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The
PackedPolicySize
response element indicates by percentage how close the policies and tags for your request are to the upper size limit.You can pass a session tag with the same key as a tag that is already attached to the role. When you do, session tags override a role tag with the same key.
Tag key–value pairs are not case sensitive, but case is preserved. This means that you cannot have separate
Department
anddepartment
tag keys. Assume that the role has theDepartment
=Marketing
tag and you pass thedepartment
=engineering
session tag.Department
anddepartment
are not saved as separate tags, and the session tag passed in the request takes precedence over the role tag.Additionally, if you used temporary credentials to perform this operation, the new session inherits any transitive session tags from the calling session. If you pass a session tag with the same key as an inherited tag, the operation fails. To view the inherited tags for a session, see the CloudTrail logs. For more information, see Viewing Session Tags in CloudTrail in the IAM User Guide.
- Parameters:
tags
- A list of session tags that you want to pass. Each session tag consists of a key name and an associated value. For more information about session tags, see Tagging Amazon Web Services STS Sessions in the IAM User Guide.This parameter is optional. You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters, and the values can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The
PackedPolicySize
response element indicates by percentage how close the policies and tags for your request are to the upper size limit.You can pass a session tag with the same key as a tag that is already attached to the role. When you do, session tags override a role tag with the same key.
Tag key–value pairs are not case sensitive, but case is preserved. This means that you cannot have separate
Department
anddepartment
tag keys. Assume that the role has theDepartment
=Marketing
tag and you pass thedepartment
=engineering
session tag.Department
anddepartment
are not saved as separate tags, and the session tag passed in the request takes precedence over the role tag.Additionally, if you used temporary credentials to perform this operation, the new session inherits any transitive session tags from the calling session. If you pass a session tag with the same key as an inherited tag, the operation fails. To view the inherited tags for a session, see the CloudTrail logs. For more information, see Viewing Session Tags in CloudTrail in the IAM User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of session tags that you want to pass. Each session tag consists of a key name and an associated value. For more information about session tags, see Tagging Amazon Web Services STS Sessions in the IAM User Guide.
This parameter is optional. You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters, and the values can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The
PackedPolicySize
response element indicates by percentage how close the policies and tags for your request are to the upper size limit.You can pass a session tag with the same key as a tag that is already attached to the role. When you do, session tags override a role tag with the same key.
Tag key–value pairs are not case sensitive, but case is preserved. This means that you cannot have separate
Department
anddepartment
tag keys. Assume that the role has theDepartment
=Marketing
tag and you pass thedepartment
=engineering
session tag.Department
anddepartment
are not saved as separate tags, and the session tag passed in the request takes precedence over the role tag.Additionally, if you used temporary credentials to perform this operation, the new session inherits any transitive session tags from the calling session. If you pass a session tag with the same key as an inherited tag, the operation fails. To view the inherited tags for a session, see the CloudTrail logs. For more information, see Viewing Session Tags in CloudTrail in the IAM User Guide.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
transitiveTagKeys
A list of keys for session tags that you want to set as transitive. If you set a tag key as transitive, the corresponding key and value passes to subsequent sessions in a role chain. For more information, see Chaining Roles with Session Tags in the IAM User Guide.
This parameter is optional. When you set session tags as transitive, the session policy and session tags packed binary limit is not affected.
If you choose not to specify a transitive tag key, then no tags are passed from this session to any subsequent sessions.
- Parameters:
transitiveTagKeys
- A list of keys for session tags that you want to set as transitive. If you set a tag key as transitive, the corresponding key and value passes to subsequent sessions in a role chain. For more information, see Chaining Roles with Session Tags in the IAM User Guide.This parameter is optional. When you set session tags as transitive, the session policy and session tags packed binary limit is not affected.
If you choose not to specify a transitive tag key, then no tags are passed from this session to any subsequent sessions.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
transitiveTagKeys
A list of keys for session tags that you want to set as transitive. If you set a tag key as transitive, the corresponding key and value passes to subsequent sessions in a role chain. For more information, see Chaining Roles with Session Tags in the IAM User Guide.
This parameter is optional. When you set session tags as transitive, the session policy and session tags packed binary limit is not affected.
If you choose not to specify a transitive tag key, then no tags are passed from this session to any subsequent sessions.
- Parameters:
transitiveTagKeys
- A list of keys for session tags that you want to set as transitive. If you set a tag key as transitive, the corresponding key and value passes to subsequent sessions in a role chain. For more information, see Chaining Roles with Session Tags in the IAM User Guide.This parameter is optional. When you set session tags as transitive, the session policy and session tags packed binary limit is not affected.
If you choose not to specify a transitive tag key, then no tags are passed from this session to any subsequent sessions.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
externalId
A unique identifier that might be required when you assume a role in another account. If the administrator of the account to which the role belongs provided you with an external ID, then provide that value in the
ExternalId
parameter. This value can be any string, such as a passphrase or account number. A cross-account role is usually set up to trust everyone in an account. Therefore, the administrator of the trusting account might send an external ID to the administrator of the trusted account. That way, only someone with the ID can assume the role, rather than everyone in the account. For more information about the external ID, see How to Use an External ID When Granting Access to Your Amazon Web Services Resources to a Third Party in the IAM User Guide.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: =,.@:/-
- Parameters:
externalId
- A unique identifier that might be required when you assume a role in another account. If the administrator of the account to which the role belongs provided you with an external ID, then provide that value in theExternalId
parameter. This value can be any string, such as a passphrase or account number. A cross-account role is usually set up to trust everyone in an account. Therefore, the administrator of the trusting account might send an external ID to the administrator of the trusted account. That way, only someone with the ID can assume the role, rather than everyone in the account. For more information about the external ID, see How to Use an External ID When Granting Access to Your Amazon Web Services Resources to a Third Party in the IAM User Guide.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:
- Returns a reference to this object so that method calls can be chained together.
-
serialNumber
The identification number of the MFA device that is associated with the user who is making the
AssumeRole
call. Specify this value if the trust policy of the role being assumed includes a condition that requires MFA authentication. The value is either the serial number for a hardware device (such asGAHT12345678
) or an Amazon Resource Name (ARN) for a virtual device (such asarn:aws:iam::123456789012:mfa/user
).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: =,.@-
- Parameters:
serialNumber
- The identification number of the MFA device that is associated with the user who is making theAssumeRole
call. Specify this value if the trust policy of the role being assumed includes a condition that requires MFA authentication. The value is either the serial number for a hardware device (such asGAHT12345678
) or an Amazon Resource Name (ARN) for a virtual device (such asarn:aws:iam::123456789012:mfa/user
).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:
- Returns a reference to this object so that method calls can be chained together.
-
tokenCode
The value provided by the MFA device, if the trust policy of the role being assumed requires MFA. (In other words, if the policy includes a condition that tests for MFA). If the role being assumed requires MFA and if the
TokenCode
value is missing or expired, theAssumeRole
call returns an "access denied" error.The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.
- Parameters:
tokenCode
- The value provided by the MFA device, if the trust policy of the role being assumed requires MFA. (In other words, if the policy includes a condition that tests for MFA). If the role being assumed requires MFA and if theTokenCode
value is missing or expired, theAssumeRole
call returns an "access denied" error.The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceIdentity
The source identity specified by the principal that is calling the
AssumeRole
operation.You can require users to specify a source identity when they assume a role. You do this by using the
sts:SourceIdentity
condition key in a role trust policy. You can use source identity information in CloudTrail logs to determine who took actions with a role. You can use theaws:SourceIdentity
condition key to further control access to Amazon Web Services resources based on the value of source identity. For more information about using source identity, see Monitor and control actions taken with assumed roles in the IAM User Guide.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: =,.@-. You cannot use a value that begins with the text
aws:
. This prefix is reserved for Amazon Web Services internal use.- Parameters:
sourceIdentity
- The source identity specified by the principal that is calling theAssumeRole
operation.You can require users to specify a source identity when they assume a role. You do this by using the
sts:SourceIdentity
condition key in a role trust policy. You can use source identity information in CloudTrail logs to determine who took actions with a role. You can use theaws:SourceIdentity
condition key to further control access to Amazon Web Services resources based on the value of source identity. For more information about using source identity, see Monitor and control actions taken with assumed roles in the IAM User Guide.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: =,.@-. You cannot use a value that begins with the text
aws:
. This prefix is reserved for Amazon Web Services internal use.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
providedContexts
A list of previously acquired trusted context assertions in the format of a JSON array. The trusted context assertion is signed and encrypted by Amazon Web Services STS.
The following is an example of a
ProvidedContext
value that includes a single trusted context assertion and the ARN of the context provider from which the trusted context assertion was generated.[{"ProviderArn":"arn:aws:iam::aws:contextProvider/IdentityCenter","ContextAssertion":"trusted-context-assertion"}]
- Parameters:
providedContexts
- A list of previously acquired trusted context assertions in the format of a JSON array. The trusted context assertion is signed and encrypted by Amazon Web Services STS.The following is an example of a
ProvidedContext
value that includes a single trusted context assertion and the ARN of the context provider from which the trusted context assertion was generated.[{"ProviderArn":"arn:aws:iam::aws:contextProvider/IdentityCenter","ContextAssertion":"trusted-context-assertion"}]
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
providedContexts
A list of previously acquired trusted context assertions in the format of a JSON array. The trusted context assertion is signed and encrypted by Amazon Web Services STS.
The following is an example of a
ProvidedContext
value that includes a single trusted context assertion and the ARN of the context provider from which the trusted context assertion was generated.[{"ProviderArn":"arn:aws:iam::aws:contextProvider/IdentityCenter","ContextAssertion":"trusted-context-assertion"}]
- Parameters:
providedContexts
- A list of previously acquired trusted context assertions in the format of a JSON array. The trusted context assertion is signed and encrypted by Amazon Web Services STS.The following is an example of a
ProvidedContext
value that includes a single trusted context assertion and the ARN of the context provider from which the trusted context assertion was generated.[{"ProviderArn":"arn:aws:iam::aws:contextProvider/IdentityCenter","ContextAssertion":"trusted-context-assertion"}]
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
providedContexts
A list of previously acquired trusted context assertions in the format of a JSON array. The trusted context assertion is signed and encrypted by Amazon Web Services STS.
The following is an example of a
ProvidedContext
value that includes a single trusted context assertion and the ARN of the context provider from which the trusted context assertion was generated.[{"ProviderArn":"arn:aws:iam::aws:contextProvider/IdentityCenter","ContextAssertion":"trusted-context-assertion"}]
ProvidedContext.Builder
avoiding the need to create one manually viaProvidedContext.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toprovidedContexts(List<ProvidedContext>)
.- Parameters:
providedContexts
- a consumer that will call methods onProvidedContext.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
AssumeRoleRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
AssumeRoleRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-