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

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Attaches a resource-based policy to a private CA.

A policy can also be applied by sharing a private CA through AWS Resource Access Manager (RAM). For more information, see Attach a Policy for Cross-Account Access.

The policy can be displayed with GetPolicy and removed with DeletePolicy.

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 PutPolicy = PutPolicy' {
- resourceArn :: Text
- policy :: Text
}
newPutPolicy :: Text -> Text -> PutPolicy
putPolicy_resourceArn :: Lens' PutPolicy Text
putPolicy_policy :: Lens' PutPolicy Text
data PutPolicyResponse = PutPolicyResponse' {
}
newPutPolicyResponse :: PutPolicyResponse

Creating a Request

data PutPolicy Source #

See: newPutPolicy smart constructor.

Constructors

PutPolicy'

Fields

resourceArn :: Text
The Amazon Resource Number (ARN) of the private CA to associate with the policy. The ARN of the CA can be found by calling the ListCertificateAuthorities action.
policy :: Text
The path and file name of a JSON-formatted IAM policy to attach to the specified private CA resource. If this policy does not contain all required statements or if it includes any statement that is not allowed, the PutPolicy action returns an InvalidPolicyException. For information about IAM policy and statement structure, see Overview of JSON Policies.

Instances

Instances details

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

newPutPolicy Source #

Arguments

:: Text	`$sel:resourceArn:PutPolicy'`
-> Text	`$sel:policy:PutPolicy'`
-> PutPolicy

Create a value of PutPolicy 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:PutPolicy', putPolicy_resourceArn - The Amazon Resource Number (ARN) of the private CA to associate with the policy. The ARN of the CA can be found by calling the ListCertificateAuthorities action.

$sel:policy:PutPolicy', putPolicy_policy - The path and file name of a JSON-formatted IAM policy to attach to the specified private CA resource. If this policy does not contain all required statements or if it includes any statement that is not allowed, the PutPolicy action returns an InvalidPolicyException. For information about IAM policy and statement structure, see Overview of JSON Policies.

Request Lenses

putPolicy_resourceArn :: Lens' PutPolicy Text Source #

The Amazon Resource Number (ARN) of the private CA to associate with the policy. The ARN of the CA can be found by calling the ListCertificateAuthorities action.

putPolicy_policy :: Lens' PutPolicy Text Source #

The path and file name of a JSON-formatted IAM policy to attach to the specified private CA resource. If this policy does not contain all required statements or if it includes any statement that is not allowed, the PutPolicy action returns an InvalidPolicyException. For information about IAM policy and statement structure, see Overview of JSON Policies.

Destructuring the Response

data PutPolicyResponse Source #

See: newPutPolicyResponse smart constructor.

Constructors

PutPolicyResponse'

Instances

Instances details

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

newPutPolicyResponse :: PutPolicyResponse Source #

Create a value of PutPolicyResponse with all optional fields omitted.

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