Struct scratchstack_aws_principal::details::FederatedUserDetails

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

Details about a federated user.

Fields

partition: String

The partition this principal exists in.

account_id: String

The account id.

user_name: String

Name of the principal, case-insensitive.

data: T

Principal flavor-specific data.

Implementations

impl<T: Data> FederatedUserDetails<T>

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

where S1: Into<String>, S2: Into<String>, S3: Into<String>,

Create a FederatedUserDetails 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.
• 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 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 FederatedUserDetails object is returned. Otherwise, a PrincipalError error is returned.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl From<FederatedUserDetails<TokenInfo>> for FederatedUserDetails<()>

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

Converts to this type from the input type.

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

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

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

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

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

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

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