templates

Creates, updates, deletes or gets a template resource or lists templates in a region

Overview

Name	templates
Type	Resource
Description	Represents a template that defines certificate configurations, both for issuance and client handling
Id	aws.pcaconnectorad.templates

Fields

Name	Datatype	Description
connector_arn	string
definition	undefined
name	string
reenroll_all_certificate_holders	boolean
tags	object
template_arn	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ConnectorArn, Definition, Name, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all templates in a region.

SELECT
region,
connector_arn,
definition,
name,
reenroll_all_certificate_holders,
tags,
template_arn
FROM aws.pcaconnectorad.templates
WHERE region = 'us-east-1';

Gets all properties from an individual template.

SELECT
region,
connector_arn,
definition,
name,
reenroll_all_certificate_holders,
tags,
template_arn
FROM aws.pcaconnectorad.templates
WHERE region = 'us-east-1' AND data__Identifier = '<TemplateArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.pcaconnectorad.templates (
 ConnectorArn,
 Definition,
 Name,
 region
)
SELECT 
'{{ ConnectorArn }}',
 '{{ Definition }}',
 '{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.pcaconnectorad.templates (
 ConnectorArn,
 Definition,
 Name,
 ReenrollAllCertificateHolders,
 Tags,
 region
)
SELECT 
 '{{ ConnectorArn }}',
 '{{ Definition }}',
 '{{ Name }}',
 '{{ ReenrollAllCertificateHolders }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: template
    props:
      - name: ConnectorArn
        value: '{{ ConnectorArn }}'
      - name: Definition
        value: null
      - name: Name
        value: '{{ Name }}'
      - name: ReenrollAllCertificateHolders
        value: '{{ ReenrollAllCertificateHolders }}'
      - name: Tags
        value: {}

DELETE example

/*+ delete */
DELETE FROM aws.pcaconnectorad.templates
WHERE data__Identifier = '<TemplateArn>'
AND region = 'us-east-1';

Permissions

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

Create

pca-connector-ad:CreateTemplate

Read

pca-connector-ad:GetTemplate,
pca-connector-ad:ListTagsForResource

Update

pca-connector-ad:ListTagsForResource,
pca-connector-ad:TagResource,
pca-connector-ad:UntagResource,
pca-connector-ad:UpdateTemplate

Delete

pca-connector-ad:GetTemplate,
pca-connector-ad:DeleteTemplate

List

pca-connector-ad:ListTemplates