Struct Role

#[non_exhaustive]
pub struct Role {
    pub path: String,
    pub role_name: String,
    pub role_id: String,
    pub arn: String,
    pub create_date: DateTime,
    pub assume_role_policy_document: Option<String>,
    pub description: Option<String>,
    pub max_session_duration: Option<i32>,
    pub permissions_boundary: Option<AttachedPermissionsBoundary>,
    pub tags: Option<Vec<Tag>>,
    pub role_last_used: Option<RoleLastUsed>,
}

Contains information about an IAM role. This structure is returned as a response element in several API operations that interact with roles.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

path: String

The path to the role. For more information about paths, see IAM identifiers in the IAM User Guide.

role_name: String

The friendly name that identifies the role.

role_id: String

The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide.

arn: String

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide guide.

create_date: DateTime

The date and time, in ISO 8601 date-time format, when the role was created.

assume_role_policy_document: Option<String>

The policy that grants an entity permission to assume the role.

description: Option<String>

A description of the role that you provide.

max_session_duration: Option<i32>

The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter.

permissions_boundary: Option<AttachedPermissionsBoundary>

The ARN of the policy used to set the permissions boundary for the role.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

tags: Option<Vec<Tag>>

A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

role_last_used: Option<RoleLastUsed>

Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide.

Implementations

impl Role

pub fn path(&self) -> &str

The path to the role. For more information about paths, see IAM identifiers in the IAM User Guide.

pub fn role_name(&self) -> &str

The friendly name that identifies the role.

pub fn role_id(&self) -> &str

The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide.

pub fn arn(&self) -> &str

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide guide.

pub fn create_date(&self) -> &DateTime

The date and time, in ISO 8601 date-time format, when the role was created.

pub fn assume_role_policy_document(&self) -> Option<&str>

The policy that grants an entity permission to assume the role.

pub fn description(&self) -> Option<&str>

A description of the role that you provide.

pub fn max_session_duration(&self) -> Option<i32>

The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter.

pub fn permissions_boundary(&self) -> Option<&AttachedPermissionsBoundary>

The ARN of the policy used to set the permissions boundary for the role.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

pub fn tags(&self) -> &[Tag]

A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn role_last_used(&self) -> Option<&RoleLastUsed>

Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide.

impl Role

pub fn builder() -> RoleBuilder

Creates a new builder-style object to manufacture Role.

Trait Implementations

impl Clone for Role

fn clone(&self) -> Role

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Role

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

Formats the value using the given formatter.

impl PartialEq for Role

fn eq(&self, other: &Role) -> bool

Tests for self and other values to be equal, and is used by ==.

const 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 StructuralPartialEq for Role