Amazonka.CertificateManagerPCA.UpdateCertificateAuthority

Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the ACTIVE or DISABLED state before you can update it. You can disable a private CA that is in the ACTIVE state or make a CA that is in the DISABLED state active again.

Both Amazon Web Services Private CA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.

Creating a Request

data UpdateCertificateAuthority

See: newUpdateCertificateAuthority smart constructor.

Constructors

UpdateCertificateAuthority'

Fields

• revocationConfiguration :: Maybe RevocationConfiguration

  Contains information to enable Online Certificate Status Protocol (OCSP) support, to enable a certificate revocation list (CRL), to enable both, or to enable neither. If this parameter is not supplied, existing capibilites remain unchanged. For more information, see the OcspConfiguration and CrlConfiguration types.

  The following requirements apply to revocation configurations.

  • A configuration disabling CRLs or OCSP must contain only the Enabled=False parameter, and will fail if other parameters such as CustomCname or ExpirationInDays are included.
  • In a CRL configuration, the S3BucketName parameter must conform to Amazon S3 bucket naming rules.
  • A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
  • In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".
• status :: Maybe CertificateAuthorityStatus

  Status of your private CA.

• certificateAuthorityArn :: Text

  Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:

  arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

Instances

ToJSON UpdateCertificateAuthority

Defined in Amazonka.CertificateManagerPCA.UpdateCertificateAuthority

Methods

toJSON :: UpdateCertificateAuthority -> Value

toEncoding :: UpdateCertificateAuthority -> Encoding

toJSONList :: [UpdateCertificateAuthority] -> Value

toEncodingList :: [UpdateCertificateAuthority] -> Encoding

ToHeaders UpdateCertificateAuthority

Defined in Amazonka.CertificateManagerPCA.UpdateCertificateAuthority

Methods

toHeaders :: UpdateCertificateAuthority -> [Header]

ToPath UpdateCertificateAuthority

Defined in Amazonka.CertificateManagerPCA.UpdateCertificateAuthority

Methods

toPath :: UpdateCertificateAuthority -> ByteString

ToQuery UpdateCertificateAuthority

Defined in Amazonka.CertificateManagerPCA.UpdateCertificateAuthority

Methods

toQuery :: UpdateCertificateAuthority -> QueryString

AWSRequest UpdateCertificateAuthority

Defined in Amazonka.CertificateManagerPCA.UpdateCertificateAuthority

Associated Types

type AWSResponse UpdateCertificateAuthority

Methods

request :: (Service -> Service) -> UpdateCertificateAuthority -> Request UpdateCertificateAuthority

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateCertificateAuthority -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateCertificateAuthority)))

Generic UpdateCertificateAuthority

Defined in Amazonka.CertificateManagerPCA.UpdateCertificateAuthority

Associated Types

type Rep UpdateCertificateAuthority :: Type -> Type

Methods

from :: UpdateCertificateAuthority -> Rep UpdateCertificateAuthority x

to :: Rep UpdateCertificateAuthority x -> UpdateCertificateAuthority

Read UpdateCertificateAuthority

Defined in Amazonka.CertificateManagerPCA.UpdateCertificateAuthority

Methods

readsPrec :: Int -> ReadS UpdateCertificateAuthority

readList :: ReadS [UpdateCertificateAuthority]

readPrec :: ReadPrec UpdateCertificateAuthority

readListPrec :: ReadPrec [UpdateCertificateAuthority]

Show UpdateCertificateAuthority

Defined in Amazonka.CertificateManagerPCA.UpdateCertificateAuthority

Methods

showsPrec :: Int -> UpdateCertificateAuthority -> ShowS

show :: UpdateCertificateAuthority -> String

showList :: [UpdateCertificateAuthority] -> ShowS

NFData UpdateCertificateAuthority

Defined in Amazonka.CertificateManagerPCA.UpdateCertificateAuthority

Methods

rnf :: UpdateCertificateAuthority -> ()

Eq UpdateCertificateAuthority

Defined in Amazonka.CertificateManagerPCA.UpdateCertificateAuthority

Methods

(==) :: UpdateCertificateAuthority -> UpdateCertificateAuthority -> Bool

(/=) :: UpdateCertificateAuthority -> UpdateCertificateAuthority -> Bool

Hashable UpdateCertificateAuthority

Defined in Amazonka.CertificateManagerPCA.UpdateCertificateAuthority

Methods

hashWithSalt :: Int -> UpdateCertificateAuthority -> Int

hash :: UpdateCertificateAuthority -> Int

type AWSResponse UpdateCertificateAuthority

Defined in Amazonka.CertificateManagerPCA.UpdateCertificateAuthority

type AWSResponse UpdateCertificateAuthority = UpdateCertificateAuthorityResponse

type Rep UpdateCertificateAuthority

Defined in Amazonka.CertificateManagerPCA.UpdateCertificateAuthority

type Rep UpdateCertificateAuthority = D1 ('MetaData "UpdateCertificateAuthority" "Amazonka.CertificateManagerPCA.UpdateCertificateAuthority" "amazonka-certificatemanager-pca-2.0-BrCc8DEClV63rMSVXz2XYH" 'False) (C1 ('MetaCons "UpdateCertificateAuthority'" 'PrefixI 'True) (S1 ('MetaSel ('Just "revocationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RevocationConfiguration)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CertificateAuthorityStatus)) :*: S1 ('MetaSel ('Just "certificateAuthorityArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateCertificateAuthority

Arguments

:: Text

UpdateCertificateAuthority

-> UpdateCertificateAuthority

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

UpdateCertificateAuthority, updateCertificateAuthority_revocationConfiguration - Contains information to enable Online Certificate Status Protocol (OCSP) support, to enable a certificate revocation list (CRL), to enable both, or to enable neither. If this parameter is not supplied, existing capibilites remain unchanged. For more information, see the OcspConfiguration and CrlConfiguration types.

The following requirements apply to revocation configurations.

• A configuration disabling CRLs or OCSP must contain only the Enabled=False parameter, and will fail if other parameters such as CustomCname or ExpirationInDays are included.
• In a CRL configuration, the S3BucketName parameter must conform to Amazon S3 bucket naming rules.
• A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
• In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".

UpdateCertificateAuthority, updateCertificateAuthority_status - Status of your private CA.

UpdateCertificateAuthority, updateCertificateAuthority_certificateAuthorityArn - Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

Request Lenses

updateCertificateAuthority_revocationConfiguration :: Lens' UpdateCertificateAuthority (Maybe RevocationConfiguration)

Contains information to enable Online Certificate Status Protocol (OCSP) support, to enable a certificate revocation list (CRL), to enable both, or to enable neither. If this parameter is not supplied, existing capibilites remain unchanged. For more information, see the OcspConfiguration and CrlConfiguration types.

The following requirements apply to revocation configurations.

• A configuration disabling CRLs or OCSP must contain only the Enabled=False parameter, and will fail if other parameters such as CustomCname or ExpirationInDays are included.
• In a CRL configuration, the S3BucketName parameter must conform to Amazon S3 bucket naming rules.
• A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
• In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".

updateCertificateAuthority_status :: Lens' UpdateCertificateAuthority (Maybe CertificateAuthorityStatus)

Status of your private CA.

updateCertificateAuthority_certificateAuthorityArn :: Lens' UpdateCertificateAuthority Text

Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

Destructuring the Response

data UpdateCertificateAuthorityResponse

See: newUpdateCertificateAuthorityResponse smart constructor.

Constructors

UpdateCertificateAuthorityResponse'

Instances

Generic UpdateCertificateAuthorityResponse

Defined in Amazonka.CertificateManagerPCA.UpdateCertificateAuthority

Associated Types

type Rep UpdateCertificateAuthorityResponse :: Type -> Type

Methods

from :: UpdateCertificateAuthorityResponse -> Rep UpdateCertificateAuthorityResponse x

to :: Rep UpdateCertificateAuthorityResponse x -> UpdateCertificateAuthorityResponse

Read UpdateCertificateAuthorityResponse

Defined in Amazonka.CertificateManagerPCA.UpdateCertificateAuthority

Methods

readsPrec :: Int -> ReadS UpdateCertificateAuthorityResponse

readList :: ReadS [UpdateCertificateAuthorityResponse]

readPrec :: ReadPrec UpdateCertificateAuthorityResponse

readListPrec :: ReadPrec [UpdateCertificateAuthorityResponse]

Show UpdateCertificateAuthorityResponse

Defined in Amazonka.CertificateManagerPCA.UpdateCertificateAuthority

Methods

showsPrec :: Int -> UpdateCertificateAuthorityResponse -> ShowS

show :: UpdateCertificateAuthorityResponse -> String

showList :: [UpdateCertificateAuthorityResponse] -> ShowS

NFData UpdateCertificateAuthorityResponse

Defined in Amazonka.CertificateManagerPCA.UpdateCertificateAuthority

Methods

rnf :: UpdateCertificateAuthorityResponse -> ()

Eq UpdateCertificateAuthorityResponse

Defined in Amazonka.CertificateManagerPCA.UpdateCertificateAuthority

Methods

(==) :: UpdateCertificateAuthorityResponse -> UpdateCertificateAuthorityResponse -> Bool

(/=) :: UpdateCertificateAuthorityResponse -> UpdateCertificateAuthorityResponse -> Bool

type Rep UpdateCertificateAuthorityResponse

Defined in Amazonka.CertificateManagerPCA.UpdateCertificateAuthority

type Rep UpdateCertificateAuthorityResponse = D1 ('MetaData "UpdateCertificateAuthorityResponse" "Amazonka.CertificateManagerPCA.UpdateCertificateAuthority" "amazonka-certificatemanager-pca-2.0-BrCc8DEClV63rMSVXz2XYH" 'False) (C1 ('MetaCons "UpdateCertificateAuthorityResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateCertificateAuthorityResponse :: UpdateCertificateAuthorityResponse

Create a value of UpdateCertificateAuthorityResponse with all optional fields omitted.

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