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

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Grants one or more permissions on a private CA to the Certificate Manager (ACM) service principal (acm.amazonaws.com). These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA.

You can list current permissions with the ListPermissions action and revoke them with the DeletePermission 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 Amazon Web Services Private CA.

Creating a Request

data CreatePermission Source #

See: newCreatePermission smart constructor.

Constructors

CreatePermission'

Fields

sourceAccount :: Maybe Text
The ID of the calling account.
certificateAuthorityArn :: Text
The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the 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 Amazon Web Services service or identity that receives the permission. At this time, the only valid principal is acm.amazonaws.com.
actions :: NonEmpty ActionType
The actions that the specified Amazon Web Services service principal can use. These include IssueCertificate, GetCertificate, and ListPermissions.

Instances

Instances details

ToJSON CreatePermission Source #
Instance details Defined in Amazonka.CertificateManagerPCA.CreatePermission Methods toJSON :: CreatePermission -> Value # toEncoding :: CreatePermission -> Encoding # toJSONList :: [CreatePermission] -> Value # toEncodingList :: [CreatePermission] -> Encoding #
ToHeaders CreatePermission Source #
Instance details Defined in Amazonka.CertificateManagerPCA.CreatePermission Methods toHeaders :: CreatePermission -> [Header] #
ToPath CreatePermission Source #
Instance details Defined in Amazonka.CertificateManagerPCA.CreatePermission Methods toPath :: CreatePermission -> ByteString #
ToQuery CreatePermission Source #
Instance details Defined in Amazonka.CertificateManagerPCA.CreatePermission Methods toQuery :: CreatePermission -> QueryString #
AWSRequest CreatePermission Source #
Instance details Defined in Amazonka.CertificateManagerPCA.CreatePermission Associated Types type AWSResponse CreatePermission # Methods request :: (Service -> Service) -> CreatePermission -> Request CreatePermission # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreatePermission -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreatePermission))) #
Generic CreatePermission Source #
Instance details Defined in Amazonka.CertificateManagerPCA.CreatePermission Associated Types type Rep CreatePermission :: Type -> Type # Methods from :: CreatePermission -> Rep CreatePermission x # to :: Rep CreatePermission x -> CreatePermission #
Read CreatePermission Source #
Instance details Defined in Amazonka.CertificateManagerPCA.CreatePermission Methods readsPrec :: Int -> ReadS CreatePermission # readList :: ReadS [CreatePermission] # readPrec :: ReadPrec CreatePermission # readListPrec :: ReadPrec [CreatePermission] #
Show CreatePermission Source #
Instance details Defined in Amazonka.CertificateManagerPCA.CreatePermission Methods showsPrec :: Int -> CreatePermission -> ShowS # show :: CreatePermission -> String # showList :: [CreatePermission] -> ShowS #
NFData CreatePermission Source #
Instance details Defined in Amazonka.CertificateManagerPCA.CreatePermission Methods rnf :: CreatePermission -> () #
Eq CreatePermission Source #
Instance details Defined in Amazonka.CertificateManagerPCA.CreatePermission Methods (==) :: CreatePermission -> CreatePermission -> Bool # (/=) :: CreatePermission -> CreatePermission -> Bool #
Hashable CreatePermission Source #
Instance details Defined in Amazonka.CertificateManagerPCA.CreatePermission Methods hashWithSalt :: Int -> CreatePermission -> Int # hash :: CreatePermission -> Int #
type AWSResponse CreatePermission Source #
Instance details Defined in Amazonka.CertificateManagerPCA.CreatePermission type AWSResponse CreatePermission = CreatePermissionResponse
type Rep CreatePermission Source #
Instance details Defined in Amazonka.CertificateManagerPCA.CreatePermission type Rep CreatePermission = D1 ('MetaData "CreatePermission" "Amazonka.CertificateManagerPCA.CreatePermission" "amazonka-certificatemanager-pca-2.0-BrCc8DEClV63rMSVXz2XYH" 'False) (C1 ('MetaCons "CreatePermission'" '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) :*: S1 ('MetaSel ('Just "actions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty ActionType)))))

newCreatePermission Source #

Arguments

:: Text	`CreatePermission`
-> Text	`CreatePermission`
-> NonEmpty ActionType	`CreatePermission`
-> CreatePermission

Create a value of CreatePermission 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:

CreatePermission, createPermission_sourceAccount - The ID of the calling account.

CreatePermission, createPermission_certificateAuthorityArn - The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the 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 .

CreatePermission, createPermission_principal - The Amazon Web Services service or identity that receives the permission. At this time, the only valid principal is acm.amazonaws.com.

CreatePermission, createPermission_actions - The actions that the specified Amazon Web Services service principal can use. These include IssueCertificate, GetCertificate, and ListPermissions.

Request Lenses

createPermission_sourceAccount :: Lens' CreatePermission (Maybe Text) Source #

The ID of the calling account.

createPermission_certificateAuthorityArn :: Lens' CreatePermission Text Source #

The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the 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 .

createPermission_principal :: Lens' CreatePermission Text Source #

The Amazon Web Services service or identity that receives the permission. At this time, the only valid principal is acm.amazonaws.com.

createPermission_actions :: Lens' CreatePermission (NonEmpty ActionType) Source #

The actions that the specified Amazon Web Services service principal can use. These include IssueCertificate, GetCertificate, and ListPermissions.

Destructuring the Response

data CreatePermissionResponse Source #

See: newCreatePermissionResponse smart constructor.

Constructors

CreatePermissionResponse'

Instances

Instances details

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

newCreatePermissionResponse :: CreatePermissionResponse Source #

Create a value of CreatePermissionResponse with all optional fields omitted.

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