com.amazonaws.services.securitytoken.model

Class FederatedUser

java.lang.Object

com.amazonaws.services.securitytoken.model.FederatedUser

All Implemented Interfaces:

Serializable, Cloneable

public class FederatedUser
extends Object
implements Serializable, Cloneable

Identifiers for the federated user that is associated with the credentials.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FederatedUser() Default constructor for a new FederatedUser object.
FederatedUser(String federatedUserId, String arn) Constructs a new FederatedUser object.

Method Summary

Methods

Modifier and Type	Method and Description
FederatedUser	clone()
boolean	equals(Object obj)
String	getArn() The ARN that specifies the federated user that is associated with the credentials.
String	getFederatedUserId() The string that identifies the federated user associated with the credentials, similar to the unique ID of an IAM user.
int	hashCode()
void	setArn(String arn) The ARN that specifies the federated user that is associated with the credentials.
void	setFederatedUserId(String federatedUserId) The string that identifies the federated user associated with the credentials, similar to the unique ID of an IAM user.
String	toString() Returns a string representation of this object; useful for testing and debugging.
FederatedUser	withArn(String arn) The ARN that specifies the federated user that is associated with the credentials.
FederatedUser	withFederatedUserId(String federatedUserId) The string that identifies the federated user associated with the credentials, similar to the unique ID of an IAM user.

Methods inherited from class java.lang.Object

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

Constructor Detail

FederatedUser

public FederatedUser()

Default constructor for a new FederatedUser object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

FederatedUser

public FederatedUser(String federatedUserId,
             String arn)

Constructs a new FederatedUser object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

federatedUserId - The string that identifies the federated user associated with the credentials, similar to the unique ID of an IAM user.

arn - The ARN that specifies the federated user that is associated with the credentials. For more information about ARNs and how to use them in policies, see IAM Identifiers in Using IAM.

Method Detail

getFederatedUserId

public String getFederatedUserId()

The string that identifies the federated user associated with the credentials, similar to the unique ID of an IAM user.

Constraints:
Length: 2 - 96
Pattern: [\w+=,.@\:-]*

Returns:

The string that identifies the federated user associated with the credentials, similar to the unique ID of an IAM user.

setFederatedUserId

public void setFederatedUserId(String federatedUserId)

The string that identifies the federated user associated with the credentials, similar to the unique ID of an IAM user.

Constraints:
Length: 2 - 96
Pattern: [\w+=,.@\:-]*

Parameters:

federatedUserId - The string that identifies the federated user associated with the credentials, similar to the unique ID of an IAM user.

withFederatedUserId

public FederatedUser withFederatedUserId(String federatedUserId)

The string that identifies the federated user associated with the credentials, similar to the unique ID of an IAM user.

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

Constraints:
Length: 2 - 96
Pattern: [\w+=,.@\:-]*

Parameters:

federatedUserId - The string that identifies the federated user associated with the credentials, similar to the unique ID of an IAM user.

Returns:

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

getArn

public String getArn()

The ARN that specifies the federated user that is associated with the credentials. For more information about ARNs and how to use them in policies, see IAM Identifiers in Using IAM.

Constraints:
Length: 20 - 2048

Returns:

The ARN that specifies the federated user that is associated with the credentials. For more information about ARNs and how to use them in policies, see IAM Identifiers in Using IAM.

setArn

public void setArn(String arn)

The ARN that specifies the federated user that is associated with the credentials. For more information about ARNs and how to use them in policies, see IAM Identifiers in Using IAM.

Constraints:
Length: 20 - 2048

Parameters:

arn - The ARN that specifies the federated user that is associated with the credentials. For more information about ARNs and how to use them in policies, see IAM Identifiers in Using IAM.

withArn

public FederatedUser withArn(String arn)

The ARN that specifies the federated user that is associated with the credentials. For more information about ARNs and how to use them in policies, see IAM Identifiers in Using IAM.

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

Constraints:
Length: 20 - 2048

Parameters:

arn - The ARN that specifies the federated user that is associated with the credentials. For more information about ARNs and how to use them in policies, see IAM Identifiers in Using IAM.

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

clone

public FederatedUser clone()

Overrides:

clone in class Object