Class GetFederationTokenResult
- java.lang.Object
-
- com.amazonaws.services.securitytoken.model.GetFederationTokenResult
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class GetFederationTokenResult extends Object implements Serializable, Cloneable
Contains the response to a successful GetFederationToken request, including temporary AWS credentials that can be used to make AWS requests.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description GetFederationTokenResult()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GetFederationTokenResult
clone()
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 asarn:aws:sts::123456789012:federated-user/Bob
or123456789012: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 asarn:aws:sts::123456789012:federated-user/Bob
or123456789012: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 asarn:aws:sts::123456789012:federated-user/Bob
or123456789012:Bob
).GetFederationTokenResult
withPackedPolicySize(Integer packedPolicySize)
A percentage value indicating 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 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.
- 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.
-
setFederatedUser
public void setFederatedUser(FederatedUser federatedUser)
Identifiers for the federated user associated with the credentials (such as
arn:aws:sts::123456789012:federated-user/Bob
or123456789012:Bob
). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy.- Parameters:
federatedUser
- Identifiers for the federated user associated with the credentials (such asarn:aws:sts::123456789012:federated-user/Bob
or123456789012:Bob
). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy.
-
getFederatedUser
public FederatedUser getFederatedUser()
Identifiers for the federated user associated with the credentials (such as
arn:aws:sts::123456789012:federated-user/Bob
or123456789012:Bob
). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy.- Returns:
- Identifiers for the federated user associated with the
credentials (such as
arn:aws:sts::123456789012:federated-user/Bob
or123456789012:Bob
). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy.
-
withFederatedUser
public GetFederationTokenResult withFederatedUser(FederatedUser federatedUser)
Identifiers for the federated user associated with the credentials (such as
arn:aws:sts::123456789012:federated-user/Bob
or123456789012:Bob
). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy.- Parameters:
federatedUser
- Identifiers for the federated user associated with the credentials (such asarn:aws:sts::123456789012:federated-user/Bob
or123456789012:Bob
). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPackedPolicySize
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.
- Parameters:
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.
-
getPackedPolicySize
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.
- Returns:
- 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.
-
withPackedPolicySize
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.
- Parameters:
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:
- 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 GetFederationTokenResult clone()
-
-