Enum scratchstack_aws_principal::PrincipalIdentity

pub enum PrincipalIdentity {
    AssumedRole(AssumedRole),
    CanonicalUser(CanonicalUser),
    FederatedUser(FederatedUser),
    RootUser(RootUser),
    Service(Service),
    User(User),
}

A principal identity that is the source of an action in an AWS (or AWS-like) service.

From conversions are provided for each specific type of identity.

Examples

let pi: PrincipalIdentity = User::from_str("arn:aws:iam::123456789012:user/username").unwrap().into();
assert_eq!(pi.as_user().unwrap().user_name(), "username");

Variants

AssumedRole(AssumedRole)

Details for an assumed role.

CanonicalUser(CanonicalUser)

Details for an S3 canonical user.

FederatedUser(FederatedUser)

Details for a federated user.

RootUser(RootUser)

Details for the root user of an account.

Service(Service)

Details for a service.

User(User)

Details for an IAM user.

Implementations

impl PrincipalIdentity

pub fn source(&self) -> PrincipalSource

Return the source of this principal.

pub fn has_arn(&self) -> bool

Indicates whether this principal has an associated ARN.

To obtain the ARN, use code similar to the following:

let ident = PrincipalIdentity::User(User::new("aws", "123456789012", "/", "username").unwrap());
if ident.has_arn() {
    let arn: Arn = ident.try_into().unwrap();
}

pub fn as_assumed_role(&self) -> Option<&AssumedRole>

If the principal identity is an assumed role, return it. Otherwise, return None.

pub fn as_canonical_user(&self) -> Option<&CanonicalUser>

If the principal identity is a canonical user, return it. Otherwise, return None.

pub fn as_federated_user(&self) -> Option<&FederatedUser>

If the principal identity is a federated user, return it. Otherwise, return None.

pub fn as_root_user(&self) -> Option<&RootUser>

If the principal identity is a root user, return it. Otherwise, return None.

pub fn as_service(&self) -> Option<&Service>

If the principal identity is a service, return it. Otherwise, return None.

pub fn as_user(&self) -> Option<&User>

If the principal identity is a user, return it. Otherwise, return None.

pub fn parse_arn(arn: &str) -> Result<Self, PrincipalError>

Parse an ARN, possibly returning a principal identity. This is mainly a convenience function for unit tests.

Example

let pi = PrincipalIdentity::parse_arn("arn:aws:iam::123456789012:user/username").unwrap();
assert!(pi.as_user().is_some());

Trait Implementations

impl Clone for PrincipalIdentity

fn clone(&self) -> PrincipalIdentity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PrincipalIdentity

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

Formats the value using the given formatter.

impl Display for PrincipalIdentity

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

Formats the value using the given formatter.

impl From<AssumedRole> for PrincipalIdentity

Wrap an AssumedRole in a PrincipalIdentity.

fn from(assumed_role: AssumedRole) -> Self

Converts to this type from the input type.

impl From<CanonicalUser> for PrincipalIdentity

Wrap a CanonicalUser in a PrincipalIdentity.

fn from(canonical_user: CanonicalUser) -> 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 From<RootUser> for PrincipalIdentity

Wrap a RootUser in a PrincipalIdentity.

fn from(root_user: RootUser) -> Self

Converts to this type from the input type.

impl From<Service> for PrincipalIdentity

Wrap a Service in a PrincipalIdentity.

fn from(service: Service) -> Self

Converts to this type from the input type.

impl From<User> for PrincipalIdentity

Wrap a User in a PrincipalIdentity.

fn from(user: User) -> Self

Converts to this type from the input type.

impl Hash for PrincipalIdentity

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 PrincipalIdentity

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<PrincipalIdentity> for PrincipalIdentity

fn eq(&self, other: &PrincipalIdentity) -> 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 PartialOrd<PrincipalIdentity> for PrincipalIdentity

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl TryFrom<&PrincipalIdentity> for Arn

type Error = PrincipalError

The type returned in the event of a conversion error.

fn try_from(p: &PrincipalIdentity) -> Result<Arn, Self::Error>

Performs the conversion.

impl TryFrom<PrincipalIdentity> for Arn

type Error = PrincipalError

The type returned in the event of a conversion error.

fn try_from(p: PrincipalIdentity) -> Result<Arn, Self::Error>

Performs the conversion.

impl Eq for PrincipalIdentity

impl StructuralEq for PrincipalIdentity

impl StructuralPartialEq for PrincipalIdentity