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 |
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.
Synopsis
- data UpdateCertificateAuthority = UpdateCertificateAuthority' {}
- newUpdateCertificateAuthority :: Text -> UpdateCertificateAuthority
- updateCertificateAuthority_revocationConfiguration :: Lens' UpdateCertificateAuthority (Maybe RevocationConfiguration)
- updateCertificateAuthority_status :: Lens' UpdateCertificateAuthority (Maybe CertificateAuthorityStatus)
- updateCertificateAuthority_certificateAuthorityArn :: Lens' UpdateCertificateAuthority Text
- data UpdateCertificateAuthorityResponse = UpdateCertificateAuthorityResponse' {
- newUpdateCertificateAuthorityResponse :: UpdateCertificateAuthorityResponse
Creating a Request
data UpdateCertificateAuthority Source #
See: newUpdateCertificateAuthority
smart constructor.
UpdateCertificateAuthority' | |
|
Instances
newUpdateCertificateAuthority Source #
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 asCustomCname
orExpirationInDays
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) Source #
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 asCustomCname
orExpirationInDays
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) Source #
Status of your private CA.
updateCertificateAuthority_certificateAuthorityArn :: Lens' UpdateCertificateAuthority Text Source #
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 Source #
See: newUpdateCertificateAuthorityResponse
smart constructor.
Instances
Generic UpdateCertificateAuthorityResponse Source # | |
Defined in Amazonka.CertificateManagerPCA.UpdateCertificateAuthority type Rep UpdateCertificateAuthorityResponse :: Type -> Type # | |
Read UpdateCertificateAuthorityResponse Source # | |
Show UpdateCertificateAuthorityResponse Source # | |
NFData UpdateCertificateAuthorityResponse Source # | |
Eq UpdateCertificateAuthorityResponse Source # | |
type Rep UpdateCertificateAuthorityResponse Source # | |
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 Source #
Create a value of UpdateCertificateAuthorityResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.