com.amazonaws.services.securitytoken.model

Class AssumeRoleResult

java.lang.Object

com.amazonaws.services.securitytoken.model.AssumeRoleResult

All Implemented Interfaces:

Serializable

public class AssumeRoleResult
extends Object
implements Serializable

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 and Description
AssumeRoleResult()

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AssumeRoleResult

public AssumeRoleResult()

Method Detail

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.

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.

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.

Returns a reference to this object so that method calls can be chained together.

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:

A reference to this updated object so that method calls can be chained together.

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 called AssumeRole.

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 called AssumeRole.

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 called AssumeRole.

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 the RoleSessionName that you specified when you called AssumeRole.

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 called AssumeRole.

Returns a reference to this object so that method calls can be chained together.

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 the RoleSessionName that you specified when you called AssumeRole.

Returns:

A reference to this updated object so that method calls can be chained together.

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.

Constraints:
Range: 0 -

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.

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.

Constraints:
Range: 0 -

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.

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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 0 -

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:

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