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

Description

Revokes permissions on a private CA granted to the AWS Certificate Manager (ACM) service principal (acm.amazonaws.com).

These permissions allow ACM to issue and renew ACM certificates that reside in the same AWS account as the CA. If you revoke these permissions, ACM will no longer renew the affected certificates automatically.

Permissions can be granted with the CreatePermission action and listed with the ListPermissions action.

About Permissions

  • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.
  • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.
  • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.
Synopsis

Creating a Request

data DeletePermission Source #

See: newDeletePermission smart constructor.

Constructors

DeletePermission' 

Fields

  • sourceAccount :: Maybe Text

    The AWS account that calls this action.

  • certificateAuthorityArn :: Text

    The Amazon Resource Number (ARN) of the private CA that issued the permissions. You can find the CA's ARN by calling the ListCertificateAuthorities action. This must have the following form:

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

  • principal :: Text

    The AWS service or identity that will have its CA permissions revoked. At this time, the only valid service principal is acm.amazonaws.com

Instances

Instances details
Eq DeletePermission Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeletePermission

Read DeletePermission Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeletePermission

Show DeletePermission Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeletePermission

Generic DeletePermission Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeletePermission

Associated Types

type Rep DeletePermission :: Type -> Type #

NFData DeletePermission Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeletePermission

Methods

rnf :: DeletePermission -> () #

Hashable DeletePermission Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeletePermission

ToJSON DeletePermission Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeletePermission

AWSRequest DeletePermission Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeletePermission

Associated Types

type AWSResponse DeletePermission #

ToHeaders DeletePermission Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeletePermission

ToPath DeletePermission Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeletePermission

ToQuery DeletePermission Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeletePermission

type Rep DeletePermission Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeletePermission

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

Defined in Amazonka.CertificateManagerPCA.DeletePermission

newDeletePermission Source #

Create a value of DeletePermission 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:sourceAccount:DeletePermission', deletePermission_sourceAccount - The AWS account that calls this action.

$sel:certificateAuthorityArn:DeletePermission', deletePermission_certificateAuthorityArn - The Amazon Resource Number (ARN) of the private CA that issued the permissions. You can find the CA's ARN by calling the ListCertificateAuthorities action. This must have the following form:

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

$sel:principal:DeletePermission', deletePermission_principal - The AWS service or identity that will have its CA permissions revoked. At this time, the only valid service principal is acm.amazonaws.com

Request Lenses

deletePermission_sourceAccount :: Lens' DeletePermission (Maybe Text) Source #

The AWS account that calls this action.

deletePermission_certificateAuthorityArn :: Lens' DeletePermission Text Source #

The Amazon Resource Number (ARN) of the private CA that issued the permissions. You can find the CA's ARN by calling the ListCertificateAuthorities action. This must have the following form:

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

deletePermission_principal :: Lens' DeletePermission Text Source #

The AWS service or identity that will have its CA permissions revoked. At this time, the only valid service principal is acm.amazonaws.com

Destructuring the Response

data DeletePermissionResponse Source #

See: newDeletePermissionResponse smart constructor.

Instances

Instances details
Eq DeletePermissionResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeletePermission

Read DeletePermissionResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeletePermission

Show DeletePermissionResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeletePermission

Generic DeletePermissionResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeletePermission

Associated Types

type Rep DeletePermissionResponse :: Type -> Type #

NFData DeletePermissionResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeletePermission

type Rep DeletePermissionResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DeletePermission

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

newDeletePermissionResponse :: DeletePermissionResponse Source #

Create a value of DeletePermissionResponse with all optional fields omitted.

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