AssumeRoleRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.securitytoken.model.AssumeRoleRequest

All Implemented Interfaces:

Serializable
```
public class AssumeRoleRequest
extends AmazonWebServiceRequest
implements Serializable
```
Container for the parameters to the AssumeRole operation.
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 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 Roles in Using IAM .

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 Scenarios for Granting Temporary Access in AWS Security Token Service .

The temporary security credentials are valid for the duration that you specified when calling AssumeRole , which can be from 900 seconds (15 minutes) to 3600 seconds (1 hour). The default is 1 hour.

Optionally, you can pass an AWS IAM access policy to this operation. The temporary security credentials that are returned by the operation have the permissions that are associated with the access policy of the role that is being assumed, except for any permissions explicitly denied by the policy you pass. This gives you a way to further restrict the permissions for the federated user. These policies and any applicable resource-based policies are evaluated when calls to AWS are made using the temporary security credentials.

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 IAM role is created. You must also have a policy that allows you to call sts:AssumeRole .

Important: You cannot call AssumeRole by using AWS account credentials; access will be denied. You must use IAM user credentials or temporary security credentials to call AssumeRole .

See Also:
AWSSecurityTokenService.assumeRole(AssumeRoleRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description

AssumeRoleRequest()

Constructors
Constructor and Description
`AssumeRoleRequest()`

Method Summary

Methods
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 to assume a role in their customers' accounts.
`String`	`getPolicy()` An AWS IAM policy in JSON format.
`String`	`getRoleArn()` The Amazon Resource Name (ARN) of the role that the caller is assuming.
`String`	`getRoleSessionName()` An identifier for the assumed role session.
`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 to assume a role in their customers' accounts.
`void`	`setPolicy(String policy)` An AWS IAM policy in JSON format.
`void`	`setRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the role that the caller is assuming.
`void`	`setRoleSessionName(String roleSessionName)` An identifier for the assumed role session.
`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 to assume a role in their customers' accounts.
`AssumeRoleRequest`	`withPolicy(String policy)` An AWS IAM policy in JSON format.
`AssumeRoleRequest`	`withRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the role that the caller is assuming.
`AssumeRoleRequest`	`withRoleSessionName(String roleSessionName)` An identifier for the assumed role session.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AssumeRoleRequest
```
public AssumeRoleRequest()
```
- Method Detail
  - getRoleArn
```
public String getRoleArn()
```
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
    Constraints:
    Length: 20 - 2048
    
    Returns:
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
    Constraints:
    Length: 20 - 2048
    
    Parameters:
    roleArn - The Amazon Resource Name (ARN) of the role that the caller is assuming.
  - withRoleArn
```
public AssumeRoleRequest withRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 20 - 2048
    
    Parameters:
    roleArn - The Amazon Resource Name (ARN) of the role that the caller is assuming.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getRoleSessionName
```
public String getRoleSessionName()
```
    An identifier for the assumed role session. The session name is included as part of the AssumedRoleUser.
    Constraints:
    Length: 2 - 32
    Pattern: [\w+=,.@-]*
    
    Returns:
    An identifier for the assumed role session. The session name is included as part of the AssumedRoleUser.
  - setRoleSessionName
```
public void setRoleSessionName(String roleSessionName)
```
    An identifier for the assumed role session. The session name is included as part of the AssumedRoleUser.
    Constraints:
    Length: 2 - 32
    Pattern: [\w+=,.@-]*
    
    Parameters:
    roleSessionName - An identifier for the assumed role session. The session name is included as part of the AssumedRoleUser.
  - withRoleSessionName
```
public AssumeRoleRequest withRoleSessionName(String roleSessionName)
```
    An identifier for the assumed role session. The session name is included as part of the AssumedRoleUser.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 2 - 32
    Pattern: [\w+=,.@-]*
    
    Parameters:
    roleSessionName - An identifier for the assumed role session. The session name is included as part of the AssumedRoleUser.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getPolicy
```
public String getPolicy()
```
    An AWS IAM policy in JSON format.
    The temporary security credentials that are returned by the operation have the permissions that are associated with the access policy of the role being assumed, except for any permissions explicitly denied by the policy you pass. This gives you a way to further restrict the permissions for the federated user. These policies and any applicable resource-based policies are evaluated when calls to AWS are made using the temporary security credentials.
    Constraints:
    Length: 1 - 2048
    Pattern: [ -ÿ]+
    
    Returns:
    An AWS IAM policy in JSON format.
    The temporary security credentials that are returned by the operation have the permissions that are associated with the access policy of the role being assumed, except for any permissions explicitly denied by the policy you pass. This gives you a way to further restrict the permissions for the federated user. These policies and any applicable resource-based policies are evaluated when calls to AWS are made using the temporary security credentials.
  - setPolicy
```
public void setPolicy(String policy)
```
    An AWS IAM policy in JSON format.
    The temporary security credentials that are returned by the operation have the permissions that are associated with the access policy of the role being assumed, except for any permissions explicitly denied by the policy you pass. This gives you a way to further restrict the permissions for the federated user. These policies and any applicable resource-based policies are evaluated when calls to AWS are made using the temporary security credentials.
    Constraints:
    Length: 1 - 2048
    Pattern: [ -ÿ]+
    
    Parameters:
    policy - An AWS IAM policy in JSON format.
    The temporary security credentials that are returned by the operation have the permissions that are associated with the access policy of the role being assumed, except for any permissions explicitly denied by the policy you pass. This gives you a way to further restrict the permissions for the federated user. These policies and any applicable resource-based policies are evaluated when calls to AWS are made using the temporary security credentials.
  - withPolicy
```
public AssumeRoleRequest withPolicy(String policy)
```
    An AWS IAM policy in JSON format.
    The temporary security credentials that are returned by the operation have the permissions that are associated with the access policy of the role being assumed, except for any permissions explicitly denied by the policy you pass. This gives you a way to further restrict the permissions for the federated user. These policies and any applicable resource-based policies are evaluated when calls to AWS are made using the temporary security credentials.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 2048
    Pattern: [ -ÿ]+
    
    Parameters:
    policy - An AWS IAM policy in JSON format.
    The temporary security credentials that are returned by the operation have the permissions that are associated with the access policy of the role being assumed, except for any permissions explicitly denied by the policy you pass. This gives you a way to further restrict the permissions for the federated user. These policies and any applicable resource-based policies are evaluated when calls to AWS are made using the temporary security credentials.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDurationSeconds
```
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
    
    Returns:
    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.
  - setDurationSeconds
```
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
    
    Parameters:
    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.
  - withDurationSeconds
```
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
    
    Parameters:
    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 updated object so that method calls can be chained together.
  - getExternalId
```
public String getExternalId()
```
    A unique identifier that is used by third parties to assume a role in their customers' accounts. For each role that the third party can assume, they should instruct their customers to create a role with the external ID that the third party generated. Each time the third party assumes the role, they must 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 About the External ID in Using Temporary Security Credentials.
    Constraints:
    Length: 2 - 96
    Pattern: [\w+=,.@:-]*
    
    Returns:
    A unique identifier that is used by third parties to assume a role in their customers' accounts. For each role that the third party can assume, they should instruct their customers to create a role with the external ID that the third party generated. Each time the third party assumes the role, they must 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 About the External ID in Using Temporary Security Credentials.
  - setExternalId
```
public void setExternalId(String externalId)
```
    A unique identifier that is used by third parties to assume a role in their customers' accounts. For each role that the third party can assume, they should instruct their customers to create a role with the external ID that the third party generated. Each time the third party assumes the role, they must 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 About the External ID in Using Temporary Security Credentials.
    Constraints:
    Length: 2 - 96
    Pattern: [\w+=,.@:-]*
    
    Parameters:
    externalId - A unique identifier that is used by third parties to assume a role in their customers' accounts. For each role that the third party can assume, they should instruct their customers to create a role with the external ID that the third party generated. Each time the third party assumes the role, they must 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 About the External ID in Using Temporary Security Credentials.
  - withExternalId
```
public AssumeRoleRequest withExternalId(String externalId)
```
    A unique identifier that is used by third parties to assume a role in their customers' accounts. For each role that the third party can assume, they should instruct their customers to create a role with the external ID that the third party generated. Each time the third party assumes the role, they must 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 About the External ID in Using Temporary Security Credentials.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 2 - 96
    Pattern: [\w+=,.@:-]*
    
    Parameters:
    externalId - A unique identifier that is used by third parties to assume a role in their customers' accounts. For each role that the third party can assume, they should instruct their customers to create a role with the external ID that the third party generated. Each time the third party assumes the role, they must 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 About the External ID in Using Temporary Security Credentials.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Did this page help you?

Class AssumeRoleRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

AssumeRoleRequest

Method Detail

getRoleArn

setRoleArn

withRoleArn

getRoleSessionName

setRoleSessionName

withRoleSessionName

getPolicy

setPolicy

withPolicy

getDurationSeconds

setDurationSeconds

withDurationSeconds

getExternalId

setExternalId

withExternalId

toString

hashCode

equals