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	awscc.pcaconnectorad.templates

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
template_arn	string
region	string	AWS region.

For more information, see AWS::PCAConnectorAD::Template.

Methods

Name	Resource	Accessible by	Required Params
create_resource	templates	INSERT	ConnectorArn, Definition, Name, region
delete_resource	templates	DELETE	Identifier, region
update_resource	templates	UPDATE	Identifier, PatchDocument, region
list_resources	templates_list_only	SELECT	region
get_resource	templates	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual template.

SELECT
  region,
  connector_arn,
  definition,
  name,
  reenroll_all_certificate_holders,
  tags,
  template_arn
FROM awscc.pcaconnectorad.templates
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ template_arn }}';

list (identifiers only)

Lists all templates in a region.

SELECT
  region,
  template_arn
FROM awscc.pcaconnectorad.templates_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.pcaconnectorad.templates (
  ConnectorArn,
  Definition,
  Name,
  ReenrollAllCertificateHolders,
  Tags,
  region
)
SELECT
  '{{ connector_arn }}',
  '{{ definition }}',
  '{{ name }}',
  '{{ reenroll_all_certificate_holders }}',
  '{{ 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: connector_arn
        value: '{{ connector_arn }}'
      - name: definition
        value: null
      - name: name
        value: '{{ name }}'
      - name: reenroll_all_certificate_holders
        value: '{{ reenroll_all_certificate_holders }}'
      - name: tags
        value: {}

UPDATE example

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

/*+ update */
UPDATE awscc.pcaconnectorad.templates
SET PatchDocument = string('{{ {
    "Definition": definition,
    "ReenrollAllCertificateHolders": reenroll_all_certificate_holders,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ template_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.pcaconnectorad.templates
WHERE
  Identifier = '{{ template_arn }}' AND
  region = 'us-east-1';

Permissions

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

Create

pca-connector-ad:CreateTemplate,
pca-connector-ad:TagResource

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,
pca-connector-ad:UntagResource

List

pca-connector-ad:ListTemplates