| 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.CertificateManagerPCA.RevokeCertificate
Description
Revokes a certificate that was issued inside Amazon Web Services Private
CA. If you enable a certificate revocation list (CRL) when you create or
update your private CA, information about the revoked certificates will
be included in the CRL. Amazon Web Services Private CA writes the CRL to
an S3 bucket that you specify. A CRL is typically updated approximately
30 minutes after a certificate is revoked. If for any reason the CRL
update fails, Amazon Web Services Private CA attempts makes further
attempts every 15 minutes. With Amazon CloudWatch, you can create alarms
for the metrics CRLGenerated and MisconfiguredCRLBucket. For more
information, see
Supported CloudWatch Metrics.
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.
Amazon Web Services Private CA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.
You cannot revoke a root CA self-signed certificate.
Synopsis
- data RevokeCertificate = RevokeCertificate' {}
- newRevokeCertificate :: Text -> Text -> RevocationReason -> RevokeCertificate
- revokeCertificate_certificateAuthorityArn :: Lens' RevokeCertificate Text
- revokeCertificate_certificateSerial :: Lens' RevokeCertificate Text
- revokeCertificate_revocationReason :: Lens' RevokeCertificate RevocationReason
- data RevokeCertificateResponse = RevokeCertificateResponse' {
- newRevokeCertificateResponse :: RevokeCertificateResponse
Creating a Request
data RevokeCertificate Source #
See: newRevokeCertificate smart constructor.
Constructors
| RevokeCertificate' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> RevocationReason | |
| -> RevokeCertificate |
Create a value of RevokeCertificate 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:
RevokeCertificate, revokeCertificate_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
$sel:certificateSerial:RevokeCertificate', revokeCertificate_certificateSerial - Serial number of the certificate to be revoked. This must be in
hexadecimal format. You can retrieve the serial number by calling
GetCertificate
with the Amazon Resource Name (ARN) of the certificate you want and the
ARN of your private CA. The GetCertificate action retrieves the
certificate in the PEM format. You can use the following OpenSSL command
to list the certificate in text format and copy the hexadecimal serial
number.
openssl x509 -in file_path -text -noout
You can also copy the serial number from the console or use the DescribeCertificate action in the Certificate Manager API Reference.
$sel:revocationReason:RevokeCertificate', revokeCertificate_revocationReason - Specifies why you revoked the certificate.
Request Lenses
revokeCertificate_certificateAuthorityArn :: Lens' RevokeCertificate 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
revokeCertificate_certificateSerial :: Lens' RevokeCertificate Text Source #
Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate action retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number.
openssl x509 -in file_path -text -noout
You can also copy the serial number from the console or use the DescribeCertificate action in the Certificate Manager API Reference.
revokeCertificate_revocationReason :: Lens' RevokeCertificate RevocationReason Source #
Specifies why you revoked the certificate.
Destructuring the Response
data RevokeCertificateResponse Source #
See: newRevokeCertificateResponse smart constructor.
Constructors
| RevokeCertificateResponse' | |
Instances
newRevokeCertificateResponse :: RevokeCertificateResponse Source #
Create a value of RevokeCertificateResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.