public class AssumeRoleRequest extends AmazonWebServiceRequest implements Serializable
Returns a set of temporary security credentials (consisting of an access key
ID, a secret access key, and a security token) that you can use to access AWS
resources that you might not normally have access to. Typically, you use
AssumeRole
for cross-account access or federation. For a
comparison of AssumeRole
with the other APIs that produce
temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS APIs in the IAM User Guide.
Important: You cannot call AssumeRole
by using AWS root
account credentials; access is denied. You must use credentials for an IAM
user or an IAM role to call AssumeRole
.
For cross-account access, imagine that you own multiple accounts and need to access resources in each account. You could create long-term credentials in each account to access those resources. However, managing all those credentials and remembering which one can access which account can be time consuming. Instead, you can create one set of long-term credentials in one account and then use temporary security credentials to access all the other accounts by assuming roles in those accounts. For more information about roles, see IAM Roles (Delegation and Federation) in the IAM User Guide.
For federation, you can, for example, grant single sign-on access to the AWS
Management Console. If you already have an identity and authentication system
in your corporate network, you don't have to recreate user identities in AWS
in order to grant those user identities access to AWS. Instead, after a user
has been authenticated, you call AssumeRole
(and specify the
role with the appropriate permissions) to get temporary security credentials
for that user. With those temporary security credentials, you construct a
sign-in URL that users can use to access the console. For more information,
see Common Scenarios for Temporary Credentials in the IAM User Guide.
The temporary security credentials are valid for the duration that you
specified when calling AssumeRole
, which can be from 900 seconds
(15 minutes) to a maximum of 3600 seconds (1 hour). The default is 1 hour.
The temporary security credentials created by AssumeRole
can be
used to make API calls to any AWS service with the following exception: you
cannot call the STS service's GetFederationToken
or
GetSessionToken
APIs.
Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, 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 AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide.
To assume a role, your AWS account must be trusted by the role. The trust relationship is defined in the role's trust policy when the role is created. That trust policy states which accounts are allowed to delegate access to this account's role.
The user who wants to access the role must also have permissions delegated from the role's administrator. If the user is in a different account than the role, then the user's administrator must attach a policy that allows the user to call AssumeRole on the ARN of the role in the other account. If the user is in the same account as the role, then you can either attach a policy to the user (identical to the previous different account user), or you can add the user as a principal directly in the role's trust policy
Using MFA with AssumeRole
You can optionally include multi-factor authentication (MFA) information when
you call AssumeRole
. This is useful for cross-account scenarios
in which you want to make sure that the user who is assuming the role has
been authenticated using an AWS MFA device. In that scenario, the trust
policy of the role being assumed includes a condition that tests for MFA
authentication; if the caller does not include valid MFA information, the
request to assume the role is denied. The condition in a trust policy that
tests for MFA authentication might look like the following example.
"Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}}
For more information, see Configuring MFA-Protected API Access in the IAM User Guide guide.
To use MFA with AssumeRole
, you pass values for the
SerialNumber
and TokenCode
parameters. The
SerialNumber
value identifies the user's hardware or virtual MFA
device. The TokenCode
is the time-based one-time password (TOTP)
that the MFA devices produces.
Constructor and Description |
---|
AssumeRoleRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
Integer |
getDurationSeconds()
The duration, in seconds, of the role session.
|
String |
getExternalId()
A unique identifier that is used by third parties when assuming roles in
their customers' accounts.
|
String |
getPolicy()
An IAM policy in JSON format.
|
String |
getRoleArn()
The Amazon Resource Name (ARN) of the role to assume.
|
String |
getRoleSessionName()
An identifier for the assumed role session.
|
String |
getSerialNumber()
The identification number of the MFA device that is associated with the
user who is making the
AssumeRole call. |
String |
getTokenCode()
The value provided by the MFA device, if the trust policy of the role
being assumed requires MFA (that is, if the policy includes a condition
that tests for MFA).
|
int |
hashCode() |
void |
setDurationSeconds(Integer durationSeconds)
The duration, in seconds, of the role session.
|
void |
setExternalId(String externalId)
A unique identifier that is used by third parties when assuming roles in
their customers' accounts.
|
void |
setPolicy(String policy)
An IAM policy in JSON format.
|
void |
setRoleArn(String roleArn)
The Amazon Resource Name (ARN) of the role to assume.
|
void |
setRoleSessionName(String roleSessionName)
An identifier for the assumed role session.
|
void |
setSerialNumber(String serialNumber)
The identification number of the MFA device that is associated with the
user who is making the
AssumeRole call. |
void |
setTokenCode(String tokenCode)
The value provided by the MFA device, if the trust policy of the role
being assumed requires MFA (that is, if the policy includes a condition
that tests for MFA).
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
AssumeRoleRequest |
withDurationSeconds(Integer durationSeconds)
The duration, in seconds, of the role session.
|
AssumeRoleRequest |
withExternalId(String externalId)
A unique identifier that is used by third parties when assuming roles in
their customers' accounts.
|
AssumeRoleRequest |
withPolicy(String policy)
An IAM policy in JSON format.
|
AssumeRoleRequest |
withRoleArn(String roleArn)
The Amazon Resource Name (ARN) of the role to assume.
|
AssumeRoleRequest |
withRoleSessionName(String roleSessionName)
An identifier for the assumed role session.
|
AssumeRoleRequest |
withSerialNumber(String serialNumber)
The identification number of the MFA device that is associated with the
user who is making the
AssumeRole call. |
AssumeRoleRequest |
withTokenCode(String tokenCode)
The value provided by the MFA device, if the trust policy of the role
being assumed requires MFA (that is, if the policy includes a condition
that tests for MFA).
|
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public String getRoleArn()
The Amazon Resource Name (ARN) of the role to assume.
Constraints:
Length: 20 - 2048
Pattern: [
-~
--�က0-ჿFF]+
The Amazon Resource Name (ARN) of the role to assume.
public void setRoleArn(String roleArn)
The Amazon Resource Name (ARN) of the role to assume.
Constraints:
Length: 20 - 2048
Pattern: [
-~
--�က0-ჿFF]+
roleArn
- The Amazon Resource Name (ARN) of the role to assume.
public AssumeRoleRequest withRoleArn(String roleArn)
The Amazon Resource Name (ARN) of the role to assume.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 20 - 2048
Pattern: [
-~
--�က0-ჿFF]+
roleArn
- The Amazon Resource Name (ARN) of the role to assume.
public String getRoleSessionName()
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 using the temporary security credentials will expose the role session name to the external account in their CloudTrail logs.
The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
Constraints:
Length: 2 - 64
Pattern: [\w+=,.@-]*
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 using the temporary security credentials will expose the role session name to the external account in their CloudTrail logs.
The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
public void setRoleSessionName(String 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 using the temporary security credentials will expose the role session name to the external account in their CloudTrail logs.
The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
Constraints:
Length: 2 - 64
Pattern: [\w+=,.@-]*
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 using the temporary security credentials will expose the role session name to the external account in their CloudTrail logs.
The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
public AssumeRoleRequest withRoleSessionName(String 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 using the temporary security credentials will expose the role session name to the external account in their CloudTrail logs.
The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 2 - 64
Pattern: [\w+=,.@-]*
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 using the temporary security credentials will expose the role session name to the external account in their CloudTrail logs.
The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
public String getPolicy()
An IAM policy in JSON format.
This 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 intersection of) 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 AssumeRole, AssumeRoleWithSAML, and 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 ( -ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.
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.
Constraints:
Length: 1 - 2048
Pattern: [ -ÿ]+
An IAM policy in JSON format.
This 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 intersection of) 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 AssumeRole, AssumeRoleWithSAML, and 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 ( -ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.
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.
public void setPolicy(String policy)
An IAM policy in JSON format.
This 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 intersection of) 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 AssumeRole, AssumeRoleWithSAML, and 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 ( -ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.
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.
Constraints:
Length: 1 - 2048
Pattern: [ -ÿ]+
policy
- An IAM policy in JSON format.
This 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 intersection of) 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 AssumeRole, AssumeRoleWithSAML, and 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 ( -ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.
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.
public AssumeRoleRequest withPolicy(String policy)
An IAM policy in JSON format.
This 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 intersection of) 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 AssumeRole, AssumeRoleWithSAML, and 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 ( -ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 2048
Pattern: [ -ÿ]+
policy
- An IAM policy in JSON format.
This 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 intersection of) 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 AssumeRole, AssumeRoleWithSAML, and 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 ( -ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.
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.
public Integer getDurationSeconds()
The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.
Constraints:
Range: 900 - 3600
The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.
public void setDurationSeconds(Integer durationSeconds)
The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.
Constraints:
Range: 900 - 3600
durationSeconds
- The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.
public AssumeRoleRequest withDurationSeconds(Integer durationSeconds)
The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 900 - 3600
durationSeconds
- The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.
public String getExternalId()
A unique identifier that is used by third parties when assuming roles in their customers' accounts. For each role that the third party can assume, they should instruct their customers to ensure the role's trust policy checks for the external ID that the third party generated. Each time the third party assumes the role, they should pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party in the IAM User Guide.
The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:\/-
Constraints:
Length: 2 - 1224
Pattern: [\w+=,.@:\/-]*
A unique identifier that is used by third parties when assuming roles in their customers' accounts. For each role that the third party can assume, they should instruct their customers to ensure the role's trust policy checks for the external ID that the third party generated. Each time the third party assumes the role, they should pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party in the IAM User Guide.
The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:\/-
public void setExternalId(String externalId)
A unique identifier that is used by third parties when assuming roles in their customers' accounts. For each role that the third party can assume, they should instruct their customers to ensure the role's trust policy checks for the external ID that the third party generated. Each time the third party assumes the role, they should pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party in the IAM User Guide.
The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:\/-
Constraints:
Length: 2 - 1224
Pattern: [\w+=,.@:\/-]*
externalId
- A unique identifier that is used by third parties when assuming roles in their customers' accounts. For each role that the third party can assume, they should instruct their customers to ensure the role's trust policy checks for the external ID that the third party generated. Each time the third party assumes the role, they should pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party in the IAM User Guide.
The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:\/-
public AssumeRoleRequest withExternalId(String externalId)
A unique identifier that is used by third parties when assuming roles in their customers' accounts. For each role that the third party can assume, they should instruct their customers to ensure the role's trust policy checks for the external ID that the third party generated. Each time the third party assumes the role, they should pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party in the IAM User Guide.
The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:\/-
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 2 - 1224
Pattern: [\w+=,.@:\/-]*
externalId
- A unique identifier that is used by third parties when assuming roles in their customers' accounts. For each role that the third party can assume, they should instruct their customers to ensure the role's trust policy checks for the external ID that the third party generated. Each time the third party assumes the role, they should pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party in the IAM User Guide.
The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:\/-
public String getSerialNumber()
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 as GAHT12345678
) or an Amazon Resource
Name (ARN) for a virtual device (such as
arn:aws:iam::123456789012:mfa/user
).
The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
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 as
GAHT12345678
) or an Amazon Resource Name (ARN) for a
virtual device (such as
arn:aws:iam::123456789012:mfa/user
).
The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
public void setSerialNumber(String 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 as GAHT12345678
) or an Amazon Resource
Name (ARN) for a virtual device (such as
arn:aws:iam::123456789012:mfa/user
).
The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
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 as GAHT12345678
) or an Amazon Resource Name
(ARN) for a virtual device (such as
arn:aws:iam::123456789012:mfa/user
).
The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
public AssumeRoleRequest withSerialNumber(String 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 as GAHT12345678
) or an Amazon Resource
Name (ARN) for a virtual device (such as
arn:aws:iam::123456789012:mfa/user
).
The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
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 as GAHT12345678
) or an Amazon Resource Name
(ARN) for a virtual device (such as
arn:aws:iam::123456789012:mfa/user
).
The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
public String getTokenCode()
The value provided by the MFA device, if the trust policy of the role
being assumed requires MFA (that is, 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, the
AssumeRole
call returns an "access denied" error.
The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.
Constraints:
Length: 6 - 6
Pattern: [\d]*
The value provided by the MFA device, if the trust policy of the
role being assumed requires MFA (that is, 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, the AssumeRole
call returns an
"access denied" error.
The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.
public void setTokenCode(String tokenCode)
The value provided by the MFA device, if the trust policy of the role
being assumed requires MFA (that is, 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, the
AssumeRole
call returns an "access denied" error.
The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.
Constraints:
Length: 6 - 6
Pattern: [\d]*
tokenCode
-
The value provided by the MFA device, if the trust policy of
the role being assumed requires MFA (that is, 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, the AssumeRole
call
returns an "access denied" error.
The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.
public AssumeRoleRequest withTokenCode(String tokenCode)
The value provided by the MFA device, if the trust policy of the role
being assumed requires MFA (that is, 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, the
AssumeRole
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 a reference to this object so that method calls can be chained together.
Constraints:
Length: 6 - 6
Pattern: [\d]*
tokenCode
-
The value provided by the MFA device, if the trust policy of
the role being assumed requires MFA (that is, 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, the AssumeRole
call
returns an "access denied" error.
The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.
public String toString()
toString
in class Object
Object.toString()
Copyright © 2018. All rights reserved.