public class GetFederationTokenResult extends Object implements Serializable
Contains the response to a successful GetFederationToken request, including temporary AWS credentials that can be used to make AWS requests.
Constructor and Description |
---|
GetFederationTokenResult() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(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 ). |
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(Integer packedPolicySize)
A percentage value indicating the size of the policy in packed form.
|
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(Integer packedPolicySize)
A percentage value indicating the size of the policy in packed form.
|
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.
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 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 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.
Returns a reference to this object so that method calls can be chained together.
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 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.
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 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 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.
Returns a reference to this object so that method calls can be chained together.
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 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.
Constraints:
Range: 0 -
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 setPackedPolicySize(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.
Constraints:
Range: 0 -
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 GetFederationTokenResult withPackedPolicySize(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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 0 -
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 String toString()
toString
in class Object
Object.toString()
Copyright © 2019. All rights reserved.