Struct AssumedRole

pub struct AssumedRole { /* private fields */ }

Details about an AWS STS assumed role.

AssumedRole structs are immutable.

Implementations

impl AssumedRole

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

Create an AssumedRole object.

Arguments:

• 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.
• role_name: The name of the role being assumed. This must meet the following requirements or a PrincipalError::InvalidRoleName 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 , - . = @ _.
• session_name: A name to assign to the session. This must meet the following requirements or a PrincipalError::InvalidSessionName error will be returned:
  • The session name must contain between 2 and 64 characters.
  • The session name must be composed to ASCII alphanumeric characters or one of , - . = @ _.

Return value

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

Example

let assumed_role = AssumedRole::new("aws", "123456789012", "role-name", "session-name").unwrap();
assert_eq!(assumed_role.partition(), "aws");
assert_eq!(assumed_role.account_id(), "123456789012");
assert_eq!(assumed_role.role_name(), "role-name");
assert_eq!(assumed_role.session_name(), "session-name");

pub fn partition(&self) -> &str

The partition of the assumed role.

pub fn account_id(&self) -> &str

The account ID of the assumed role.

pub fn role_name(&self) -> &str

The name of the role being assumed.

pub fn session_name(&self) -> &str

The name of the session.

Trait Implementations

impl Clone for AssumedRole

fn clone(&self) -> AssumedRole

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AssumedRole

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

Formats the value using the given formatter.

impl Display for AssumedRole

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

Formats the value using the given formatter.

impl From<&AssumedRole> for Arn

fn from(role: &AssumedRole) -> Arn

Converts to this type from the input type.

impl From<AssumedRole> for Principal

fn from(role: AssumedRole) -> Self

Converts to this type from the input type.

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 FromStr for AssumedRole

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

Parse an ARN, returning an AssumedRole if the ARN is a valid assumed role ARN.

Example

let result = AssumedRole::from_str("arn:aws:sts::123456789012:assumed-role/role-name/session-name");
assert!(result.is_ok());

type Err = PrincipalError

The associated error which can be returned from parsing.

impl Hash for AssumedRole

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 AssumedRole

fn cmp(&self, other: &AssumedRole) -> 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 AssumedRole

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

fn partial_cmp(&self, other: &AssumedRole) -> 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 TryFrom<&Arn> for AssumedRole

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

If an Arn represents a valid assumed role, convert it to an AssumedRole; otherwise, return a PrincipalError indicating what is wrong with the ARN.

Example

let arn = Arn::from_str("arn:aws:sts::123456789012:assumed-role/role-name/session-name").unwrap();
let assumed_role = AssumedRole::try_from(&arn).unwrap();
assert_eq!(assumed_role.role_name(), "role-name");
assert_eq!(assumed_role.session_name(), "session-name");

type Error = PrincipalError

The type returned in the event of a conversion error.

impl Eq for AssumedRole

impl StructuralPartialEq for AssumedRole