pub struct FederatedUser { /* private fields */ }
Expand description
Details about an AWS IAM federated user.
FederatedUser structs are immutable.
Implementations§
Source§impl FederatedUser
impl FederatedUser
Sourcepub fn new(
partition: &str,
account_id: &str,
user_name: &str,
) -> Result<Self, PrincipalError>
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");
Sourcepub fn account_id(&self) -> &str
pub fn account_id(&self) -> &str
The account ID of the user.
Trait Implementations§
Source§impl Clone for FederatedUser
impl Clone for FederatedUser
Source§fn clone(&self) -> FederatedUser
fn clone(&self) -> FederatedUser
Returns a copy of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreSource§impl Debug for FederatedUser
impl Debug for FederatedUser
Source§impl Display for FederatedUser
impl Display for FederatedUser
Source§impl From<&FederatedUser> for Arn
impl From<&FederatedUser> for Arn
Source§fn from(user: &FederatedUser) -> Arn
fn from(user: &FederatedUser) -> Arn
Converts to this type from the input type.
Source§impl From<FederatedUser> for Principal
impl From<FederatedUser> for Principal
Source§fn from(user: FederatedUser) -> Self
fn from(user: FederatedUser) -> Self
Converts to this type from the input type.
Source§impl From<FederatedUser> for PrincipalIdentity
Wrap a FederatedUser in a PrincipalIdentity.
impl From<FederatedUser> for PrincipalIdentity
Wrap a FederatedUser in a PrincipalIdentity.
Source§fn from(federated_user: FederatedUser) -> Self
fn from(federated_user: FederatedUser) -> Self
Converts to this type from the input type.
Source§impl Hash for FederatedUser
impl Hash for FederatedUser
Source§impl Ord for FederatedUser
impl Ord for FederatedUser
Source§fn cmp(&self, other: &FederatedUser) -> Ordering
fn cmp(&self, other: &FederatedUser) -> Ordering
1.21.0 · Source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the maximum of two values. Read more
Source§impl PartialEq for FederatedUser
impl PartialEq for FederatedUser
Source§impl PartialOrd for FederatedUser
impl PartialOrd for FederatedUser
impl Eq for FederatedUser
impl StructuralPartialEq for FederatedUser
Auto Trait Implementations§
impl Freeze for FederatedUser
impl RefUnwindSafe for FederatedUser
impl Send for FederatedUser
impl Sync for FederatedUser
impl Unpin for FederatedUser
impl UnwindSafe for FederatedUser
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more