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.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 Amazon Web Services Resource Access Manager (RAM), the CA will be removed from all shares in which it was included.

The 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 Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with Amazon Web Services Private CA.
A policy permits a user of 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 Amazon Web Services Private CA policy. For more information, see Using a Service Linked Role with ACM.
Updates made in Amazon Web Services 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

ToJSON DeletePolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy Methods toJSON :: DeletePolicy -> Value # toEncoding :: DeletePolicy -> Encoding # toJSONList :: [DeletePolicy] -> Value # toEncodingList :: [DeletePolicy] -> Encoding #
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 #
AWSRequest DeletePolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy Associated Types type AWSResponse DeletePolicy # Methods request :: (Service -> Service) -> DeletePolicy -> Request DeletePolicy # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeletePolicy -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeletePolicy))) #
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 #
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 #
NFData DeletePolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy Methods rnf :: DeletePolicy -> () #
Eq DeletePolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy Methods (==) :: DeletePolicy -> DeletePolicy -> Bool # (/=) :: DeletePolicy -> DeletePolicy -> Bool #
Hashable DeletePolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy Methods hashWithSalt :: Int -> DeletePolicy -> Int # hash :: DeletePolicy -> Int #
type AWSResponse DeletePolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy type AWSResponse DeletePolicy = DeletePolicyResponse
type Rep DeletePolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy type Rep DeletePolicy = D1 ('MetaData "DeletePolicy" "Amazonka.CertificateManagerPCA.DeletePolicy" "amazonka-certificatemanager-pca-2.0-BrCc8DEClV63rMSVXz2XYH" 'False) (C1 ('MetaCons "DeletePolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

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

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 #
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 #
NFData DeletePolicyResponse Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy Methods rnf :: DeletePolicyResponse -> () #
Eq DeletePolicyResponse Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy Methods (==) :: DeletePolicyResponse -> DeletePolicyResponse -> Bool # (/=) :: DeletePolicyResponse -> DeletePolicyResponse -> Bool #
type Rep DeletePolicyResponse Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DeletePolicy type Rep DeletePolicyResponse = D1 ('MetaData "DeletePolicyResponse" "Amazonka.CertificateManagerPCA.DeletePolicy" "amazonka-certificatemanager-pca-2.0-BrCc8DEClV63rMSVXz2XYH" '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.