Struct scratchstack_aws_principal::details::UserDetails

pub struct UserDetails<T: Data> {
    pub partition: String,
    pub account_id: String,
    pub path: String,
    pub user_name: String,
    pub data: T,
}

Details about an AWS IAM user.

Fields

partition: String

The partition this principal exists in.

account_id: String

The account id.

path: String

Path, starting with a /.

user_name: String

Name of the principal, case-insensitive.

data: T

Principal flavor-specific data.

Implementations

impl<T: Data> UserDetails<T>

pub fn new<S1, S2, S3, S4>(
    partition: S1,
    account_id: S2,
    path: S3,
    user_name: S4,
    data: T
) -> Result<Self, PrincipalError> where
    S1: Into<String>,
    S2: Into<String>,
    S3: Into<String>,
    S4: Into<String>, 

Create a UserDetails object.

Arguments

• account_id: The 12 digit account id. This must be composed of 12 ASCII digits or a PrincipalError::InvalidAccountId error will be returned.
• path: The IAM path the group is under. This must meet the following requirements or a PrincipalError::InvalidPath error will be returned:
  • The path must contain between 1 and 512 characters.
  • The path must start and end with /.
  • All characters in the path must be in the ASCII range 0x21 (!) through 0x7E (~). The AWS documentation erroneously indicates that 0x7F (DEL) is acceptable; however, the IAM APIs reject this character.
• user_name: The name of the user. This must meet the following requirements or a PrincipalError::InvalidUserName error will be returned:
  • The name must contain between 1 and 64 characters.
  • The name must be composed to ASCII alphanumeric characters or one of , - . = @ _.
• data: Principal flavor-specific data.

Return value

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

Trait Implementations

impl<T: Clone + Data> Clone for UserDetails<T>

fn clone(&self) -> UserDetails<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Data> Debug for UserDetails<T>

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

Formats the value using the given formatter.

impl<T: Eq + Data> Eq for UserDetails<T>

impl From<UserDetails<String>> for UserDetails<()>

fn from(from: UserDetails) -> UserDetails<()>

Performs the conversion.

impl<T: PartialEq + Data> PartialEq<UserDetails<T>> for UserDetails<T>

fn eq(&self, other: &UserDetails<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &UserDetails<T>) -> bool

This method tests for !=.

impl<T: Data> StructuralEq for UserDetails<T>

impl<T: Data> StructuralPartialEq for UserDetails<T>