Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IAM.UpdateServerCertificate

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Updates the name and/or the path of the specified server certificate stored in IAM.

For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.

You should understand the implications of changing a server certificate's path or name. For more information, see Renaming a server certificate in the IAM User Guide.

The person making the request (the principal), must have permission to change the server certificate with the old name and the new name. For example, to change the certificate named ProductionCert to ProdCert, the principal must have a policy that allows them to update both certificates. If the principal has permission to update the ProductionCert group, but not the ProdCert certificate, then the update fails. For more information about permissions, see Access management in the IAM User Guide.

Creating a Request

data UpdateServerCertificate Source #

See: newUpdateServerCertificate smart constructor.

Constructors

UpdateServerCertificate'

Fields

newPath' :: Maybe Text
The new path for the server certificate. Include this only if you are updating the server certificate's path.
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
newServerCertificateName' :: Maybe Text
The new name for the server certificate. Include this only if you are updating the server certificate's name. The name of the certificate cannot contain any spaces.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
serverCertificateName :: Text
The name of the server certificate that you want to update.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Instances

Instances details

ToHeaders UpdateServerCertificate Source #
Instance details Defined in Amazonka.IAM.UpdateServerCertificate Methods toHeaders :: UpdateServerCertificate -> [Header] #
ToPath UpdateServerCertificate Source #
Instance details Defined in Amazonka.IAM.UpdateServerCertificate Methods toPath :: UpdateServerCertificate -> ByteString #
ToQuery UpdateServerCertificate Source #
Instance details Defined in Amazonka.IAM.UpdateServerCertificate Methods toQuery :: UpdateServerCertificate -> QueryString #
AWSRequest UpdateServerCertificate Source #
Instance details Defined in Amazonka.IAM.UpdateServerCertificate Associated Types type AWSResponse UpdateServerCertificate # Methods request :: (Service -> Service) -> UpdateServerCertificate -> Request UpdateServerCertificate # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateServerCertificate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateServerCertificate))) #
Generic UpdateServerCertificate Source #
Instance details Defined in Amazonka.IAM.UpdateServerCertificate Associated Types type Rep UpdateServerCertificate :: Type -> Type # Methods from :: UpdateServerCertificate -> Rep UpdateServerCertificate x # to :: Rep UpdateServerCertificate x -> UpdateServerCertificate #
Read UpdateServerCertificate Source #
Instance details Defined in Amazonka.IAM.UpdateServerCertificate Methods readsPrec :: Int -> ReadS UpdateServerCertificate # readList :: ReadS [UpdateServerCertificate] # readPrec :: ReadPrec UpdateServerCertificate # readListPrec :: ReadPrec [UpdateServerCertificate] #
Show UpdateServerCertificate Source #
Instance details Defined in Amazonka.IAM.UpdateServerCertificate Methods showsPrec :: Int -> UpdateServerCertificate -> ShowS # show :: UpdateServerCertificate -> String # showList :: [UpdateServerCertificate] -> ShowS #
NFData UpdateServerCertificate Source #
Instance details Defined in Amazonka.IAM.UpdateServerCertificate Methods rnf :: UpdateServerCertificate -> () #
Eq UpdateServerCertificate Source #
Instance details Defined in Amazonka.IAM.UpdateServerCertificate Methods (==) :: UpdateServerCertificate -> UpdateServerCertificate -> Bool # (/=) :: UpdateServerCertificate -> UpdateServerCertificate -> Bool #
Hashable UpdateServerCertificate Source #
Instance details Defined in Amazonka.IAM.UpdateServerCertificate Methods hashWithSalt :: Int -> UpdateServerCertificate -> Int # hash :: UpdateServerCertificate -> Int #
type AWSResponse UpdateServerCertificate Source #
Instance details Defined in Amazonka.IAM.UpdateServerCertificate type AWSResponse UpdateServerCertificate = UpdateServerCertificateResponse
type Rep UpdateServerCertificate Source #
Instance details Defined in Amazonka.IAM.UpdateServerCertificate type Rep UpdateServerCertificate = D1 ('MetaData "UpdateServerCertificate" "Amazonka.IAM.UpdateServerCertificate" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "UpdateServerCertificate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "newPath'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "newServerCertificateName'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "serverCertificateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateServerCertificate Source #

Arguments

:: Text	`UpdateServerCertificate`
-> UpdateServerCertificate

Create a value of UpdateServerCertificate 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:newPath':UpdateServerCertificate', updateServerCertificate_newPath - The new path for the server certificate. Include this only if you are updating the server certificate's path.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

$sel:newServerCertificateName':UpdateServerCertificate', updateServerCertificate_newServerCertificateName - The new name for the server certificate. Include this only if you are updating the server certificate's name. The name of the certificate cannot contain any spaces.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

UpdateServerCertificate, updateServerCertificate_serverCertificateName - The name of the server certificate that you want to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Request Lenses

updateServerCertificate_newPath :: Lens' UpdateServerCertificate (Maybe Text) Source #

The new path for the server certificate. Include this only if you are updating the server certificate's path.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

updateServerCertificate_newServerCertificateName :: Lens' UpdateServerCertificate (Maybe Text) Source #

The new name for the server certificate. Include this only if you are updating the server certificate's name. The name of the certificate cannot contain any spaces.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

updateServerCertificate_serverCertificateName :: Lens' UpdateServerCertificate Text Source #

The name of the server certificate that you want to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Destructuring the Response

data UpdateServerCertificateResponse Source #

See: newUpdateServerCertificateResponse smart constructor.

Constructors

UpdateServerCertificateResponse'

Instances

Instances details

Generic UpdateServerCertificateResponse Source #
Instance details Defined in Amazonka.IAM.UpdateServerCertificate Associated Types type Rep UpdateServerCertificateResponse :: Type -> Type # Methods from :: UpdateServerCertificateResponse -> Rep UpdateServerCertificateResponse x # to :: Rep UpdateServerCertificateResponse x -> UpdateServerCertificateResponse #
Read UpdateServerCertificateResponse Source #
Instance details Defined in Amazonka.IAM.UpdateServerCertificate Methods readsPrec :: Int -> ReadS UpdateServerCertificateResponse # readList :: ReadS [UpdateServerCertificateResponse] # readPrec :: ReadPrec UpdateServerCertificateResponse # readListPrec :: ReadPrec [UpdateServerCertificateResponse] #
Show UpdateServerCertificateResponse Source #
Instance details Defined in Amazonka.IAM.UpdateServerCertificate Methods showsPrec :: Int -> UpdateServerCertificateResponse -> ShowS # show :: UpdateServerCertificateResponse -> String # showList :: [UpdateServerCertificateResponse] -> ShowS #
NFData UpdateServerCertificateResponse Source #
Instance details Defined in Amazonka.IAM.UpdateServerCertificate Methods rnf :: UpdateServerCertificateResponse -> () #
Eq UpdateServerCertificateResponse Source #
Instance details Defined in Amazonka.IAM.UpdateServerCertificate Methods (==) :: UpdateServerCertificateResponse -> UpdateServerCertificateResponse -> Bool # (/=) :: UpdateServerCertificateResponse -> UpdateServerCertificateResponse -> Bool #
type Rep UpdateServerCertificateResponse Source #
Instance details Defined in Amazonka.IAM.UpdateServerCertificate type Rep UpdateServerCertificateResponse = D1 ('MetaData "UpdateServerCertificateResponse" "Amazonka.IAM.UpdateServerCertificate" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "UpdateServerCertificateResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateServerCertificateResponse :: UpdateServerCertificateResponse Source #

Create a value of UpdateServerCertificateResponse with all optional fields omitted.

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