permissions

Creates, updates, deletes or gets a permission resource or lists permissions in a region

Overview

Name	permissions
Type	Resource
Description	Permission set on private certificate authority
Id	awscc.acmpca.permissions

Fields

Name	Datatype	Description
actions	array	The actions that the specified AWS service principal can use. Actions IssueCertificate, GetCertificate and ListPermissions must be provided.
certificate_authority_arn	string	The Amazon Resource Name (ARN) of the Private Certificate Authority that grants the permission.
principal	string	The AWS service or identity that receives the permission. At this time, the only valid principal is acm.amazonaws.com.
source_account	string	The ID of the calling account.
region	string	AWS region.

For more information, see AWS::ACMPCA::Permission.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Actions, CertificateAuthorityArn, Principal, region
delete_resource	DELETE	Identifier, region
get_resource	SELECT	Identifier, region

SELECT examples

Gets all properties from an individual permission.

SELECT
  region,
  actions,
  certificate_authority_arn,
  principal,
  source_account
FROM awscc.acmpca.permissions
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ certificate_authority_arn }}|{{ principal }}';

INSERT example

Use the following StackQL query and manifest file to create a new permission resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.acmpca.permissions (
  Actions,
  CertificateAuthorityArn,
  Principal,
  region
)
SELECT
  '{{ actions }}',
  '{{ certificate_authority_arn }}',
  '{{ principal }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.acmpca.permissions (
  Actions,
  CertificateAuthorityArn,
  Principal,
  SourceAccount,
  region
)
SELECT
  '{{ actions }}',
  '{{ certificate_authority_arn }}',
  '{{ principal }}',
  '{{ source_account }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: permission
  props:
    - name: actions
      value:
        - '{{ actions[0] }}'
    - name: certificate_authority_arn
      value: '{{ certificate_authority_arn }}'
    - name: principal
      value: '{{ principal }}'
    - name: source_account
      value: '{{ source_account }}'

DELETE example

/*+ delete */
DELETE FROM awscc.acmpca.permissions
WHERE
  Identifier = '{{ certificate_authority_arn }}|{{ principal }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the permissions resource, the following permissions are required:

Create

acm-pca:CreatePermission,
acm-pca:ListPermissions

Read

acm-pca:ListPermissions

Delete

acm-pca:DeletePermission