amazonka-opsworks-2.0: Amazon OpsWorks SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.OpsWorks.UpdateUserProfile

Description

Updates a specified user profile.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Synopsis

Creating a Request

data UpdateUserProfile Source #

See: newUpdateUserProfile smart constructor.

Constructors

UpdateUserProfile' 

Fields

  • allowSelfManagement :: Maybe Bool

    Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.

  • sshPublicKey :: Maybe Text

    The user's new SSH public key.

  • sshUsername :: Maybe Text

    The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM user name.

  • iamUserArn :: Text

    The user IAM ARN. This can also be a federated user's ARN.

Instances

Instances details
ToJSON UpdateUserProfile Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateUserProfile

ToHeaders UpdateUserProfile Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateUserProfile

ToPath UpdateUserProfile Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateUserProfile

ToQuery UpdateUserProfile Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateUserProfile

AWSRequest UpdateUserProfile Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateUserProfile

Associated Types

type AWSResponse UpdateUserProfile #

Generic UpdateUserProfile Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateUserProfile

Associated Types

type Rep UpdateUserProfile :: Type -> Type #

Read UpdateUserProfile Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateUserProfile

Show UpdateUserProfile Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateUserProfile

NFData UpdateUserProfile Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateUserProfile

Methods

rnf :: UpdateUserProfile -> () #

Eq UpdateUserProfile Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateUserProfile

Hashable UpdateUserProfile Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateUserProfile

type AWSResponse UpdateUserProfile Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateUserProfile

type Rep UpdateUserProfile Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateUserProfile

type Rep UpdateUserProfile = D1 ('MetaData "UpdateUserProfile" "Amazonka.OpsWorks.UpdateUserProfile" "amazonka-opsworks-2.0-7XrzSD2vbuN9lVUGWMVZ7S" 'False) (C1 ('MetaCons "UpdateUserProfile'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "allowSelfManagement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sshPublicKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "sshUsername") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "iamUserArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateUserProfile Source #

Create a value of UpdateUserProfile 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:

UpdateUserProfile, updateUserProfile_allowSelfManagement - Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.

UpdateUserProfile, updateUserProfile_sshPublicKey - The user's new SSH public key.

UpdateUserProfile, updateUserProfile_sshUsername - The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM user name.

UpdateUserProfile, updateUserProfile_iamUserArn - The user IAM ARN. This can also be a federated user's ARN.

Request Lenses

updateUserProfile_allowSelfManagement :: Lens' UpdateUserProfile (Maybe Bool) Source #

Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.

updateUserProfile_sshUsername :: Lens' UpdateUserProfile (Maybe Text) Source #

The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM user name.

updateUserProfile_iamUserArn :: Lens' UpdateUserProfile Text Source #

The user IAM ARN. This can also be a federated user's ARN.

Destructuring the Response

data UpdateUserProfileResponse Source #

See: newUpdateUserProfileResponse smart constructor.

Instances

Instances details
Generic UpdateUserProfileResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateUserProfile

Associated Types

type Rep UpdateUserProfileResponse :: Type -> Type #

Read UpdateUserProfileResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateUserProfile

Show UpdateUserProfileResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateUserProfile

NFData UpdateUserProfileResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateUserProfile

Eq UpdateUserProfileResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateUserProfile

type Rep UpdateUserProfileResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateUserProfile

type Rep UpdateUserProfileResponse = D1 ('MetaData "UpdateUserProfileResponse" "Amazonka.OpsWorks.UpdateUserProfile" "amazonka-opsworks-2.0-7XrzSD2vbuN9lVUGWMVZ7S" 'False) (C1 ('MetaCons "UpdateUserProfileResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateUserProfileResponse :: UpdateUserProfileResponse Source #

Create a value of UpdateUserProfileResponse with all optional fields omitted.

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