Class AssumeRoleResult
- java.lang.Object
-
- com.amazonaws.services.securitytoken.model.AssumeRoleResult
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class AssumeRoleResult extends Object implements Serializable, Cloneable
Contains the response to a successful AssumeRole request, including temporary AWS credentials that can be used to make AWS requests.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description AssumeRoleResult()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AssumeRoleResult
clone()
boolean
equals(Object obj)
AssumedRoleUser
getAssumedRoleUser()
The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials.Credentials
getCredentials()
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.Integer
getPackedPolicySize()
A percentage value that indicates the size of the policy in packed form.int
hashCode()
void
setAssumedRoleUser(AssumedRoleUser assumedRoleUser)
The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials.void
setCredentials(Credentials credentials)
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.void
setPackedPolicySize(Integer packedPolicySize)
A percentage value that indicates the size of the policy in packed form.String
toString()
Returns a string representation of this object; useful for testing and debugging.AssumeRoleResult
withAssumedRoleUser(AssumedRoleUser assumedRoleUser)
The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials.AssumeRoleResult
withCredentials(Credentials credentials)
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.AssumeRoleResult
withPackedPolicySize(Integer packedPolicySize)
A percentage value that indicates the size of the policy in packed form.
-
-
-
Method Detail
-
setCredentials
public void setCredentials(Credentials credentials)
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
- Parameters:
credentials
- The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
-
getCredentials
public Credentials getCredentials()
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
- Returns:
- The temporary security credentials, which include an access key
ID, a secret access key, and a security (or session) token.
Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
-
withCredentials
public AssumeRoleResult withCredentials(Credentials credentials)
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
- Parameters:
credentials
- The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAssumedRoleUser
public void setAssumedRoleUser(AssumedRoleUser assumedRoleUser)
The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the
RoleSessionName
that you specified when you calledAssumeRole
.- Parameters:
assumedRoleUser
- The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include theRoleSessionName
that you specified when you calledAssumeRole
.
-
getAssumedRoleUser
public AssumedRoleUser getAssumedRoleUser()
The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the
RoleSessionName
that you specified when you calledAssumeRole
.- Returns:
- The Amazon Resource Name (ARN) and the assumed role ID, which are
identifiers that you can use to refer to the resulting temporary
security credentials. For example, you can reference these
credentials as a principal in a resource-based policy by using
the ARN or assumed role ID. The ARN and ID include the
RoleSessionName
that you specified when you calledAssumeRole
.
-
withAssumedRoleUser
public AssumeRoleResult withAssumedRoleUser(AssumedRoleUser assumedRoleUser)
The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the
RoleSessionName
that you specified when you calledAssumeRole
.- Parameters:
assumedRoleUser
- The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include theRoleSessionName
that you specified when you calledAssumeRole
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPackedPolicySize
public void setPackedPolicySize(Integer packedPolicySize)
A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.
- Parameters:
packedPolicySize
- A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.
-
getPackedPolicySize
public Integer getPackedPolicySize()
A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.
- Returns:
- A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.
-
withPackedPolicySize
public AssumeRoleResult withPackedPolicySize(Integer packedPolicySize)
A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.
- Parameters:
packedPolicySize
- A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.- Returns:
- Returns a reference to this 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public AssumeRoleResult clone()
-
-