Struct UserProfileSummary

#[non_exhaustive]
pub struct UserProfileSummary {
    pub user_arn: Option<String>,
    pub display_name: Option<String>,
    pub email_address: Option<String>,
    pub ssh_public_key: Option<String>,
}

Information about a user's profile in AWS CodeStar.

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.

user_arn: Option<String>

The Amazon Resource Name (ARN) of the user in IAM.

display_name: Option<String>

The display name of a user in AWS CodeStar. For example, this could be set to both first and last name ("Mary Major") or a single name ("Mary"). The display name is also used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will be used as the second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example "Mary Jane Major") would generate an initial icon using the first character and the first character after the space ("MJ", not "MM").

email_address: Option<String>

The email address associated with the user.

ssh_public_key: Option<String>

The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user's private key for SSH access.

Implementations

impl UserProfileSummary

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

The Amazon Resource Name (ARN) of the user in IAM.

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

The display name of a user in AWS CodeStar. For example, this could be set to both first and last name ("Mary Major") or a single name ("Mary"). The display name is also used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will be used as the second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example "Mary Jane Major") would generate an initial icon using the first character and the first character after the space ("MJ", not "MM").

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

The email address associated with the user.

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

The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user's private key for SSH access.

impl UserProfileSummary

pub fn builder() -> UserProfileSummaryBuilder

Creates a new builder-style object to manufacture UserProfileSummary.

Trait Implementations

impl Clone for UserProfileSummary

fn clone(&self) -> UserProfileSummary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserProfileSummary

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

Formats the value using the given formatter.

impl PartialEq for UserProfileSummary

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