public class AssumeRoleResult
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
Contains the response to a successful AssumeRole request, including temporary AWS credentials that can be used to make AWS requests.
Modifier and Type | Field and Description |
---|---|
private 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.
|
private Credentials |
credentials
The temporary security credentials, which include an access key ID, a
secret access key, and a security (or session) token.
|
private java.lang.Integer |
packedPolicySize
A percentage value that indicates the size of the policy in packed form.
|
Constructor and Description |
---|
AssumeRoleResult() |
Modifier and Type | Method and Description |
---|---|
AssumeRoleResult |
clone() |
boolean |
equals(java.lang.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.
|
java.lang.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(java.lang.Integer packedPolicySize)
A percentage value that indicates the size of the policy in packed form.
|
java.lang.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(java.lang.Integer packedPolicySize)
A percentage value that indicates the size of the policy in packed form.
|
private 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.
private 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
.
private java.lang.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.
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.
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.
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.
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.
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.
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.
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
.
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
.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
.
RoleSessionName
that you specified when you called
AssumeRole
.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
.
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
.public void setPackedPolicySize(java.lang.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.
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.public java.lang.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.
public AssumeRoleResult withPackedPolicySize(java.lang.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.
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.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public AssumeRoleResult clone()
clone
in class java.lang.Object