template_group_access_control_entries

Creates, updates, deletes or gets a template_group_access_control_entry resource or lists template_group_access_control_entries in a region

Overview

Name	template_group_access_control_entries
Type	Resource
Description	Definition of AWS::PCAConnectorAD::TemplateGroupAccessControlEntry Resource Type
Id	awscc.pcaconnectorad.template_group_access_control_entries

Fields

get (all properties)

Name	Datatype	Description
▶access_rights	object
group_display_name	string
group_security_identifier	string
template_arn	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
group_security_identifier	string
template_arn	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	template_group_access_control_entries	INSERT	AccessRights, GroupDisplayName, region
delete_resource	template_group_access_control_entries	DELETE	Identifier, region
update_resource	template_group_access_control_entries	UPDATE	Identifier, PatchDocument, region
list_resources	template_group_access_control_entries_list_only	SELECT	region
get_resource	template_group_access_control_entries	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual template_group_access_control_entry.

SELECT
  region,
  access_rights,
  group_display_name,
  group_security_identifier,
  template_arn
FROM awscc.pcaconnectorad.template_group_access_control_entries
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ group_security_identifier }}|{{ template_arn }}';

list (identifiers only)

Lists all template_group_access_control_entries in a region.

SELECT
  region,
  group_security_identifier,
  template_arn
FROM awscc.pcaconnectorad.template_group_access_control_entries_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.pcaconnectorad.template_group_access_control_entries (
  AccessRights,
  GroupDisplayName,
  region
)
SELECT
  '{{ access_rights }}',
  '{{ group_display_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.pcaconnectorad.template_group_access_control_entries (
  AccessRights,
  GroupDisplayName,
  GroupSecurityIdentifier,
  TemplateArn,
  region
)
SELECT
  '{{ access_rights }}',
  '{{ group_display_name }}',
  '{{ group_security_identifier }}',
  '{{ template_arn }}',
  '{{ 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: template_group_access_control_entry
  props:
    - name: access_rights
      value:
        enroll: '{{ enroll }}'
        auto_enroll: null
    - name: group_display_name
      value: '{{ group_display_name }}'
    - name: group_security_identifier
      value: '{{ group_security_identifier }}'
    - name: template_arn
      value: '{{ template_arn }}'

UPDATE example

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

/*+ update */
UPDATE awscc.pcaconnectorad.template_group_access_control_entries
SET PatchDocument = string('{{ {
    "AccessRights": access_rights,
    "GroupDisplayName": group_display_name
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ group_security_identifier }}|{{ template_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.pcaconnectorad.template_group_access_control_entries
WHERE
  Identifier = '{{ group_security_identifier }}|{{ template_arn }}' 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 template_group_access_control_entries resource, the following permissions are required:

Create

pca-connector-ad:CreateTemplateGroupAccessControlEntry

Read

pca-connector-ad:GetTemplateGroupAccessControlEntry

Update

pca-connector-ad:UpdateTemplateGroupAccessControlEntry

Delete

pca-connector-ad:DeleteTemplateGroupAccessControlEntry,
pca-connector-ad:GetTemplateGroupAccessControlEntry

List

pca-connector-ad:ListTemplateGroupAccessControlEntries