permissions

Creates, updates, deletes, gets or lists a permissions resource.

Overview

Name	`permissions`
Type	Resource
Id	`aws.acm_pca.permissions`

Fields

The following fields are returned by SELECT queries:

list_permissions

Name	Datatype	Description
`actions`	`array`	The private CA actions that can be performed by the designated Amazon Web Services service.
`certificate_authority_arn`	`string`	The Amazon Resource Number (ARN) of the private CA from which the permission was issued. (pattern: <code>arn:[\w+=/,.@-]+:acm-pca:[\w+=/,.@-]:[0-9]:[\w+=,.@-]+(/[\w+=,.@-]+)*</code>)
`created_at`	`string (date-time)`	The time at which the permission was created.
`policy`	`string`	The name of the policy that is associated with the permission. (pattern: <code>[\u0009\u000A\u000D\u0020-\u00FF]+</code>)
`principal`	`string`	The Amazon Web Services service or entity that holds the permission. At this time, the only valid principal is acm.amazonaws.com. (pattern: <code>[^*]+</code>)
`source_account`	`string`	The ID of the account that assigned the permission. (pattern: <code>[0-9]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Description
`list_permissions`	`select`	`region`	List all permissions on a private CA, if any, granted 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. Permissions can be granted with the CreatePermission action and revoked 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.
`create_permission`	`insert`	`region`, `CertificateAuthorityArn`	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.
`delete_permission`	`delete`	`region`	Revokes permissions on a private CA granted 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. 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 Amazon Web Services Private CA.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`region`	`string`	AWS region (default: us-east-1)

`SELECT` examples

list_permissions

List all permissions on a private CA, if any, granted 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. Permissions can be granted with the CreatePermission action and revoked 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.

SELECT
actions,
certificate_authority_arn,
created_at,
policy,
principal,
source_account
FROM aws.acm_pca.permissions
WHERE region = '{{ region }}' -- required
;

`INSERT` examples

create_permission
Manifest

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.

INSERT INTO aws.acm_pca.permissions (
CertificateAuthorityArn,
Principal,
SourceAccount,
Actions,
region
)
SELECT 
'{{ CertificateAuthorityArn }}' /* required */,
'{{ Principal }}',
'{{ SourceAccount }}',
'{{ Actions }}',
'{{ region }}'
;

# Description fields are for documentation purposes
- name: permissions
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the permissions resource.
  - name: CertificateAuthorityArn
    value: "{{ CertificateAuthorityArn }}"
    description: |
      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 .
  - name: Principal
    value: "{{ Principal }}"
    description: |
      The Amazon Web Services service or identity that receives the permission. At this time, the only valid principal is acm.amazonaws.com.
  - name: SourceAccount
    value: "{{ SourceAccount }}"
    description: |
      The ID of the calling account.
  - name: Actions
    value:
      - "{{ Actions }}"
    description: |
      The actions that the specified Amazon Web Services service principal can use. These include IssueCertificate, GetCertificate, and ListPermissions.

`DELETE` examples

delete_permission

Revokes permissions on a private CA granted 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. 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 Amazon Web Services Private CA.

DELETE FROM aws.acm_pca.permissions
WHERE region = '{{ region }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

DELETE examples​