Struct FederatedUser

pub struct FederatedUser { /* private fields */ }

Details about an AWS IAM federated user.

FederatedUser structs are immutable.

Implementations

impl FederatedUser

pub fn new( partition: &str, account_id: &str, user_name: &str, ) -> Result<Self, PrincipalError>

Create a FederatedUser object.

• partition: The partition this principal exists in.
• account_id: The 12 digit account id. This must be composed of 12 ASCII digits or a PrincipalError::InvalidAccountId error will be returned.
• user_name: The name of the federated user. This must meet the following requirements or a PrincipalError::InvalidFederatedUserName error will be returned:
  • The name must contain between 2 and 32 characters.
  • The name must be composed to ASCII alphanumeric characters or one of , - . = @ _.

If all of the requirements are met, a FederatedUser object is returned. Otherwise, a PrincipalError error is returned.

Example

let federated_user = FederatedUser::new("aws", "123456789012", "user@example.com").unwrap();
assert_eq!(federated_user.partition(), "aws");
assert_eq!(federated_user.account_id(), "123456789012");
assert_eq!(federated_user.user_name(), "user@example.com");

pub fn partition(&self) -> &str

The partition of the user.

pub fn account_id(&self) -> &str

The account ID of the user.

pub fn user_name(&self) -> &str

The name of the user.

Trait Implementations

impl Clone for FederatedUser

fn clone(&self) -> FederatedUser

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FederatedUser

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for FederatedUser

fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult

Formats the value using the given formatter.

impl From<&FederatedUser> for Arn

fn from(user: &FederatedUser) -> Arn

Converts to this type from the input type.

impl From<FederatedUser> for Principal

fn from(user: FederatedUser) -> Self

Converts to this type from the input type.

impl From<FederatedUser> for PrincipalIdentity

Wrap a FederatedUser in a PrincipalIdentity.

fn from(federated_user: FederatedUser) -> Self

Converts to this type from the input type.

impl Hash for FederatedUser

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FederatedUser

fn cmp(&self, other: &FederatedUser) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for FederatedUser

fn eq(&self, other: &FederatedUser) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for FederatedUser

fn partial_cmp(&self, other: &FederatedUser) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for FederatedUser

impl StructuralPartialEq for FederatedUser