libZSservicesZSamazonka-certificatemanager-pcaZSamazonka-certificatemanager-pca
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.CertificateManagerPCA.DeleteCertificateAuthority

Description

Deletes a private certificate authority (CA). You must provide the Amazon Resource Name (ARN) of the private CA that you want to delete. You can find the ARN by calling the ListCertificateAuthorities action.

Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy.

Before you can delete a CA that you have created and activated, you must disable it. To do this, call the UpdateCertificateAuthority action and set the CertificateAuthorityStatus parameter to DISABLED.

Additionally, you can delete a CA if you are waiting for it to be created (that is, the status of the CA is CREATING). You can also delete it if the CA has been created but you haven't yet imported the signed certificate into ACM Private CA (that is, the status of the CA is PENDING_CERTIFICATE).

When you successfully call DeleteCertificateAuthority, the CA's status changes to DELETED. However, the CA won't be permanently deleted until the restoration period has passed. By default, if you do not set the PermanentDeletionTimeInDays parameter, the CA remains restorable for 30 days. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority action returns the time remaining in the restoration window of a private CA in the DELETED state. To restore an eligible CA, call the RestoreCertificateAuthority action.

Synopsis

Creating a Request

data DeleteCertificateAuthority Source #

See: newDeleteCertificateAuthority smart constructor.

Constructors

DeleteCertificateAuthority' 

Fields

Instances

Instances details
Eq DeleteCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeleteCertificateAuthority

Read DeleteCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeleteCertificateAuthority

Show DeleteCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeleteCertificateAuthority

Generic DeleteCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeleteCertificateAuthority

Associated Types

type Rep DeleteCertificateAuthority :: Type -> Type #

NFData DeleteCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeleteCertificateAuthority

Hashable DeleteCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeleteCertificateAuthority

ToJSON DeleteCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeleteCertificateAuthority

AWSRequest DeleteCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeleteCertificateAuthority

ToHeaders DeleteCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeleteCertificateAuthority

ToPath DeleteCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeleteCertificateAuthority

ToQuery DeleteCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeleteCertificateAuthority

type Rep DeleteCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeleteCertificateAuthority

type Rep DeleteCertificateAuthority = D1 ('MetaData "DeleteCertificateAuthority" "Amazonka.CertificateManagerPCA.DeleteCertificateAuthority" "libZSservicesZSamazonka-certificatemanager-pcaZSamazonka-certificatemanager-pca" 'False) (C1 ('MetaCons "DeleteCertificateAuthority'" 'PrefixI 'True) (S1 ('MetaSel ('Just "permanentDeletionTimeInDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "certificateAuthorityArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeleteCertificateAuthority

newDeleteCertificateAuthority Source #

Create a value of DeleteCertificateAuthority 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:permanentDeletionTimeInDays:DeleteCertificateAuthority', deleteCertificateAuthority_permanentDeletionTimeInDays - The number of days to make a CA restorable after it has been deleted. This can be anywhere from 7 to 30 days, with 30 being the default.

$sel:certificateAuthorityArn:DeleteCertificateAuthority', deleteCertificateAuthority_certificateAuthorityArn - The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must have the following form:

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

Request Lenses

deleteCertificateAuthority_permanentDeletionTimeInDays :: Lens' DeleteCertificateAuthority (Maybe Natural) Source #

The number of days to make a CA restorable after it has been deleted. This can be anywhere from 7 to 30 days, with 30 being the default.

deleteCertificateAuthority_certificateAuthorityArn :: Lens' DeleteCertificateAuthority Text Source #

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must have the following form:

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

Destructuring the Response

data DeleteCertificateAuthorityResponse Source #

Instances

Instances details
Eq DeleteCertificateAuthorityResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeleteCertificateAuthority

Read DeleteCertificateAuthorityResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeleteCertificateAuthority

Show DeleteCertificateAuthorityResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeleteCertificateAuthority

Generic DeleteCertificateAuthorityResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeleteCertificateAuthority

Associated Types

type Rep DeleteCertificateAuthorityResponse :: Type -> Type #

NFData DeleteCertificateAuthorityResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeleteCertificateAuthority

type Rep DeleteCertificateAuthorityResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeleteCertificateAuthority

type Rep DeleteCertificateAuthorityResponse = D1 ('MetaData "DeleteCertificateAuthorityResponse" "Amazonka.CertificateManagerPCA.DeleteCertificateAuthority" "libZSservicesZSamazonka-certificatemanager-pcaZSamazonka-certificatemanager-pca" 'False) (C1 ('MetaCons "DeleteCertificateAuthorityResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteCertificateAuthorityResponse :: DeleteCertificateAuthorityResponse Source #

Create a value of DeleteCertificateAuthorityResponse with all optional fields omitted.

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