Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CertificateManagerPCA.DeletePolicy

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Deletes the resource-based policy attached to a private CA. Deletion will remove any access that the policy has granted. If there is no policy attached to the private CA, this action will return successful.

If you delete a policy that was applied through AWS Resource Access Manager (RAM), the CA will be removed from all shares in which it was included.

The AWS Certificate Manager Service Linked Role that the policy supports is not affected when you delete the policy.

The current policy can be shown with GetPolicy and updated with PutPolicy.

About Policies

A policy grants access on a private CA to an AWS customer account, to AWS Organizations, or to an AWS Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.
A policy permits a user of AWS Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.
For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.
Updates made in AWS Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

Synopsis

data DeletePolicy = DeletePolicy' {
- resourceArn :: Text
}
newDeletePolicy :: Text -> DeletePolicy
deletePolicy_resourceArn :: Lens' DeletePolicy Text
data DeletePolicyResponse = DeletePolicyResponse' {
}
newDeletePolicyResponse :: DeletePolicyResponse

Creating a Request

data DeletePolicy Source #

See: newDeletePolicy smart constructor.

Constructors

DeletePolicy'
Fields resourceArn :: Text The Amazon Resource Number (ARN) of the private CA that will have its policy deleted. You can find the CA's ARN by calling the ListCertificateAuthorities action. The ARN value must have the form `arn:aws:acm-pca:region:account:certificate-authority/01234567-89ab-cdef-0123-0123456789ab`.

Instances

Instances details

Eq DeletePolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy Methods (==) :: DeletePolicy -> DeletePolicy -> Bool # (/=) :: DeletePolicy -> DeletePolicy -> Bool #
Read DeletePolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy Methods readsPrec :: Int -> ReadS DeletePolicy # readList :: ReadS [DeletePolicy] # readPrec :: ReadPrec DeletePolicy # readListPrec :: ReadPrec [DeletePolicy] #
Show DeletePolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy Methods showsPrec :: Int -> DeletePolicy -> ShowS # show :: DeletePolicy -> String # showList :: [DeletePolicy] -> ShowS #
Generic DeletePolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy Associated Types type Rep DeletePolicy :: Type -> Type # Methods from :: DeletePolicy -> Rep DeletePolicy x # to :: Rep DeletePolicy x -> DeletePolicy #
NFData DeletePolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy Methods rnf :: DeletePolicy -> () #
Hashable DeletePolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy Methods hashWithSalt :: Int -> DeletePolicy -> Int # hash :: DeletePolicy -> Int #
ToJSON DeletePolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy Methods toJSON :: DeletePolicy -> Value # toEncoding :: DeletePolicy -> Encoding # toJSONList :: [DeletePolicy] -> Value # toEncodingList :: [DeletePolicy] -> Encoding #
AWSRequest DeletePolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy Associated Types type AWSResponse DeletePolicy # Methods request :: DeletePolicy -> Request DeletePolicy # response :: MonadResource m => Logger -> Service -> Proxy DeletePolicy -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeletePolicy))) #
ToHeaders DeletePolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy Methods toHeaders :: DeletePolicy -> [Header] #
ToPath DeletePolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy Methods toPath :: DeletePolicy -> ByteString #
ToQuery DeletePolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy Methods toQuery :: DeletePolicy -> QueryString #
type Rep DeletePolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy type Rep DeletePolicy = D1 ('MetaData "DeletePolicy" "Amazonka.CertificateManagerPCA.DeletePolicy" "libZSservicesZSamazonka-certificatemanager-pcaZSamazonka-certificatemanager-pca" 'False) (C1 ('MetaCons "DeletePolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeletePolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy type AWSResponse DeletePolicy = DeletePolicyResponse

newDeletePolicy Source #

Arguments

:: Text	`$sel:resourceArn:DeletePolicy'`
-> DeletePolicy

Create a value of DeletePolicy 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:resourceArn:DeletePolicy', deletePolicy_resourceArn - The Amazon Resource Number (ARN) of the private CA that will have its policy deleted. You can find the CA's ARN by calling the ListCertificateAuthorities action. The ARN value must have the form arn:aws:acm-pca:region:account:certificate-authority/01234567-89ab-cdef-0123-0123456789ab.

Request Lenses

deletePolicy_resourceArn :: Lens' DeletePolicy Text Source #

The Amazon Resource Number (ARN) of the private CA that will have its policy deleted. You can find the CA's ARN by calling the ListCertificateAuthorities action. The ARN value must have the form arn:aws:acm-pca:region:account:certificate-authority/01234567-89ab-cdef-0123-0123456789ab.

Destructuring the Response

data DeletePolicyResponse Source #

See: newDeletePolicyResponse smart constructor.

Constructors

DeletePolicyResponse'

Instances

Instances details

Eq DeletePolicyResponse Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy Methods (==) :: DeletePolicyResponse -> DeletePolicyResponse -> Bool # (/=) :: DeletePolicyResponse -> DeletePolicyResponse -> Bool #
Read DeletePolicyResponse Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy Methods readsPrec :: Int -> ReadS DeletePolicyResponse # readList :: ReadS [DeletePolicyResponse] # readPrec :: ReadPrec DeletePolicyResponse # readListPrec :: ReadPrec [DeletePolicyResponse] #
Show DeletePolicyResponse Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy Methods showsPrec :: Int -> DeletePolicyResponse -> ShowS # show :: DeletePolicyResponse -> String # showList :: [DeletePolicyResponse] -> ShowS #
Generic DeletePolicyResponse Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy Associated Types type Rep DeletePolicyResponse :: Type -> Type # Methods from :: DeletePolicyResponse -> Rep DeletePolicyResponse x # to :: Rep DeletePolicyResponse x -> DeletePolicyResponse #
NFData DeletePolicyResponse Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy Methods rnf :: DeletePolicyResponse -> () #
type Rep DeletePolicyResponse Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy type Rep DeletePolicyResponse = D1 ('MetaData "DeletePolicyResponse" "Amazonka.CertificateManagerPCA.DeletePolicy" "libZSservicesZSamazonka-certificatemanager-pcaZSamazonka-certificatemanager-pca" 'False) (C1 ('MetaCons "DeletePolicyResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeletePolicyResponse :: DeletePolicyResponse Source #

Create a value of DeletePolicyResponse with all optional fields omitted.

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