libZSservicesZSamazonka-iamZSamazonka-iam
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.IAM.UpdateServerCertificate

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.

Synopsis

Creating a Request

data UpdateServerCertificate Source #

See: newUpdateServerCertificate smart constructor.

Constructors

UpdateServerCertificate' 

Fields

  • 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: _+=,.@-

  • 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.

  • 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
Eq UpdateServerCertificate Source # 
Instance details

Defined in Amazonka.IAM.UpdateServerCertificate

Read UpdateServerCertificate Source # 
Instance details

Defined in Amazonka.IAM.UpdateServerCertificate

Show UpdateServerCertificate Source # 
Instance details

Defined in Amazonka.IAM.UpdateServerCertificate

Generic UpdateServerCertificate Source # 
Instance details

Defined in Amazonka.IAM.UpdateServerCertificate

Associated Types

type Rep UpdateServerCertificate :: Type -> Type #

NFData UpdateServerCertificate Source # 
Instance details

Defined in Amazonka.IAM.UpdateServerCertificate

Methods

rnf :: UpdateServerCertificate -> () #

Hashable UpdateServerCertificate Source # 
Instance details

Defined in Amazonka.IAM.UpdateServerCertificate

AWSRequest UpdateServerCertificate Source # 
Instance details

Defined in Amazonka.IAM.UpdateServerCertificate

ToHeaders UpdateServerCertificate Source # 
Instance details

Defined in Amazonka.IAM.UpdateServerCertificate

ToPath UpdateServerCertificate Source # 
Instance details

Defined in Amazonka.IAM.UpdateServerCertificate

ToQuery UpdateServerCertificate Source # 
Instance details

Defined in Amazonka.IAM.UpdateServerCertificate

type Rep UpdateServerCertificate Source # 
Instance details

Defined in Amazonka.IAM.UpdateServerCertificate

type Rep UpdateServerCertificate = D1 ('MetaData "UpdateServerCertificate" "Amazonka.IAM.UpdateServerCertificate" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "UpdateServerCertificate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "newServerCertificateName'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "newPath'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "serverCertificateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse UpdateServerCertificate Source # 
Instance details

Defined in Amazonka.IAM.UpdateServerCertificate

newUpdateServerCertificate Source #

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: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: _+=,.@-

$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:serverCertificateName: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_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_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_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.

Instances

Instances details
Eq UpdateServerCertificateResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateServerCertificate

Read UpdateServerCertificateResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateServerCertificate

Show UpdateServerCertificateResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateServerCertificate

Generic UpdateServerCertificateResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateServerCertificate

Associated Types

type Rep UpdateServerCertificateResponse :: Type -> Type #

NFData UpdateServerCertificateResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateServerCertificate

type Rep UpdateServerCertificateResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateServerCertificate

type Rep UpdateServerCertificateResponse = D1 ('MetaData "UpdateServerCertificateResponse" "Amazonka.IAM.UpdateServerCertificate" "libZSservicesZSamazonka-iamZSamazonka-iam" '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.