public class GetFederationTokenResult
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
Contains the response to a successful GetFederationToken request, including temporary AWS credentials that can be used to make AWS requests.
Modifier and Type | Field and Description |
---|---|
private Credentials |
credentials
The temporary security credentials, which include an access key ID, a
secret access key, and a security (or session) token.
|
private FederatedUser |
federatedUser
Identifiers for the federated user associated with the credentials (such
as
arn:aws:sts::123456789012:federated-user/Bob or
123456789012:Bob ). |
private java.lang.Integer |
packedPolicySize
A percentage value indicating the size of the policy in packed form.
|
Constructor and Description |
---|
GetFederationTokenResult() |
Modifier and Type | Method and Description |
---|---|
GetFederationTokenResult |
clone() |
boolean |
equals(java.lang.Object obj) |
Credentials |
getCredentials()
The temporary security credentials, which include an access key ID, a
secret access key, and a security (or session) token.
|
FederatedUser |
getFederatedUser()
Identifiers for the federated user associated with the credentials (such
as
arn:aws:sts::123456789012:federated-user/Bob or
123456789012:Bob ). |
java.lang.Integer |
getPackedPolicySize()
A percentage value indicating the size of the policy in packed form.
|
int |
hashCode() |
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 |
setFederatedUser(FederatedUser federatedUser)
Identifiers for the federated user associated with the credentials (such
as
arn:aws:sts::123456789012:federated-user/Bob or
123456789012:Bob ). |
void |
setPackedPolicySize(java.lang.Integer packedPolicySize)
A percentage value indicating the size of the policy in packed form.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
GetFederationTokenResult |
withCredentials(Credentials credentials)
The temporary security credentials, which include an access key ID, a
secret access key, and a security (or session) token.
|
GetFederationTokenResult |
withFederatedUser(FederatedUser federatedUser)
Identifiers for the federated user associated with the credentials (such
as
arn:aws:sts::123456789012:federated-user/Bob or
123456789012:Bob ). |
GetFederationTokenResult |
withPackedPolicySize(java.lang.Integer packedPolicySize)
A percentage value indicating 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 FederatedUser federatedUser
Identifiers for the federated user associated with the credentials (such
as arn:aws:sts::123456789012:federated-user/Bob
or
123456789012:Bob
). You can use the federated user's ARN in
your resource-based policies, such as an Amazon S3 bucket policy.
private java.lang.Integer packedPolicySize
A percentage value indicating the size of the policy in packed form. The service rejects policies for which the packed size is greater than 100 percent of the allowed value.
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 GetFederationTokenResult 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 setFederatedUser(FederatedUser federatedUser)
Identifiers for the federated user associated with the credentials (such
as arn:aws:sts::123456789012:federated-user/Bob
or
123456789012:Bob
). You can use the federated user's ARN in
your resource-based policies, such as an Amazon S3 bucket policy.
federatedUser
- Identifiers for the federated user associated with the credentials
(such as arn:aws:sts::123456789012:federated-user/Bob
or 123456789012:Bob
). You can use the federated
user's ARN in your resource-based policies, such as an Amazon S3
bucket policy.public FederatedUser getFederatedUser()
Identifiers for the federated user associated with the credentials (such
as arn:aws:sts::123456789012:federated-user/Bob
or
123456789012:Bob
). You can use the federated user's ARN in
your resource-based policies, such as an Amazon S3 bucket policy.
arn:aws:sts::123456789012:federated-user/Bob
or
123456789012:Bob
). You can use the federated user's
ARN in your resource-based policies, such as an Amazon S3 bucket
policy.public GetFederationTokenResult withFederatedUser(FederatedUser federatedUser)
Identifiers for the federated user associated with the credentials (such
as arn:aws:sts::123456789012:federated-user/Bob
or
123456789012:Bob
). You can use the federated user's ARN in
your resource-based policies, such as an Amazon S3 bucket policy.
federatedUser
- Identifiers for the federated user associated with the credentials
(such as arn:aws:sts::123456789012:federated-user/Bob
or 123456789012:Bob
). You can use the federated
user's ARN in your resource-based policies, such as an Amazon S3
bucket policy.public void setPackedPolicySize(java.lang.Integer packedPolicySize)
A percentage value indicating the size of the policy in packed form. The service rejects policies for which the packed size is greater than 100 percent of the allowed value.
packedPolicySize
- A percentage value indicating the size of the policy in packed
form. The service rejects policies for which the packed size is
greater than 100 percent of the allowed value.public java.lang.Integer getPackedPolicySize()
A percentage value indicating the size of the policy in packed form. The service rejects policies for which the packed size is greater than 100 percent of the allowed value.
public GetFederationTokenResult withPackedPolicySize(java.lang.Integer packedPolicySize)
A percentage value indicating the size of the policy in packed form. The service rejects policies for which the packed size is greater than 100 percent of the allowed value.
packedPolicySize
- A percentage value indicating the size of the policy in packed
form. The service rejects policies for which the packed size is
greater than 100 percent of the allowed value.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 GetFederationTokenResult clone()
clone
in class java.lang.Object