libZSservicesZSamazonka-codestarZSamazonka-codestar
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CodeStar.Types.UserProfileSummary

Description

 
Synopsis

Documentation

data UserProfileSummary Source #

Information about a user's profile in AWS CodeStar.

See: newUserProfileSummary smart constructor.

Constructors

UserProfileSummary' 

Fields

  • sshPublicKey :: Maybe Text

    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.

  • userArn :: Maybe Text

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

  • emailAddress :: Maybe (Sensitive Text)

    The email address associated with the user.

  • displayName :: Maybe (Sensitive Text)

    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").

Instances

Instances details
Eq UserProfileSummary Source # 
Instance details

Defined in Amazonka.CodeStar.Types.UserProfileSummary

Show UserProfileSummary Source # 
Instance details

Defined in Amazonka.CodeStar.Types.UserProfileSummary

Generic UserProfileSummary Source # 
Instance details

Defined in Amazonka.CodeStar.Types.UserProfileSummary

Associated Types

type Rep UserProfileSummary :: Type -> Type #

NFData UserProfileSummary Source # 
Instance details

Defined in Amazonka.CodeStar.Types.UserProfileSummary

Methods

rnf :: UserProfileSummary -> () #

Hashable UserProfileSummary Source # 
Instance details

Defined in Amazonka.CodeStar.Types.UserProfileSummary

FromJSON UserProfileSummary Source # 
Instance details

Defined in Amazonka.CodeStar.Types.UserProfileSummary

type Rep UserProfileSummary Source # 
Instance details

Defined in Amazonka.CodeStar.Types.UserProfileSummary

type Rep UserProfileSummary = D1 ('MetaData "UserProfileSummary" "Amazonka.CodeStar.Types.UserProfileSummary" "libZSservicesZSamazonka-codestarZSamazonka-codestar" 'False) (C1 ('MetaCons "UserProfileSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sshPublicKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "emailAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))))

newUserProfileSummary :: UserProfileSummary Source #

Create a value of UserProfileSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sshPublicKey:UserProfileSummary', userProfileSummary_sshPublicKey - 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.

$sel:userArn:UserProfileSummary', userProfileSummary_userArn - The Amazon Resource Name (ARN) of the user in IAM.

$sel:emailAddress:UserProfileSummary', userProfileSummary_emailAddress - The email address associated with the user.

$sel:displayName:UserProfileSummary', userProfileSummary_displayName - 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").

userProfileSummary_sshPublicKey :: Lens' UserProfileSummary (Maybe Text) Source #

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.

userProfileSummary_userArn :: Lens' UserProfileSummary (Maybe Text) Source #

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

userProfileSummary_emailAddress :: Lens' UserProfileSummary (Maybe Text) Source #

The email address associated with the user.

userProfileSummary_displayName :: Lens' UserProfileSummary (Maybe Text) Source #

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").