task_templates

Creates, updates, deletes or gets a task_template resource or lists task_templates in a region

Overview

Name	task_templates
Type	Resource
Description	Resource Type definition for AWS::Connect::TaskTemplate.
Id	aws.connect.task_templates

Fields

Name	Datatype	Description
arn	string	The identifier (arn) of the task template.
instance_arn	string	The identifier (arn) of the instance.
name	string	The name of the task template.
description	string	The description of the task template.
contact_flow_arn	string	The identifier of the contact flow.
constraints	object	The constraints for the task template
defaults	array
fields	array	The list of task template's fields
status	string	The status of the task template
client_token	string	the client token string in uuid format
tags	array	One or more tags.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	InstanceArn, 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 task_templates in a region.

SELECT
region,
arn,
instance_arn,
name,
description,
contact_flow_arn,
constraints,
defaults,
fields,
status,
client_token,
tags
FROM aws.connect.task_templates
WHERE region = 'us-east-1';

Gets all properties from an individual task_template.

SELECT
region,
arn,
instance_arn,
name,
description,
contact_flow_arn,
constraints,
defaults,
fields,
status,
client_token,
tags
FROM aws.connect.task_templates
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.connect.task_templates (
 InstanceArn,
 region
)
SELECT 
'{{ InstanceArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.connect.task_templates (
 InstanceArn,
 Name,
 Description,
 ContactFlowArn,
 Constraints,
 Defaults,
 Fields,
 Status,
 ClientToken,
 Tags,
 region
)
SELECT 
 '{{ InstanceArn }}',
 '{{ Name }}',
 '{{ Description }}',
 '{{ ContactFlowArn }}',
 '{{ Constraints }}',
 '{{ Defaults }}',
 '{{ Fields }}',
 '{{ Status }}',
 '{{ ClientToken }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: task_template
    props:
      - name: InstanceArn
        value: '{{ InstanceArn }}'
      - name: Name
        value: '{{ Name }}'
      - name: Description
        value: '{{ Description }}'
      - name: ContactFlowArn
        value: '{{ ContactFlowArn }}'
      - name: Constraints
        value:
          InvisibleFields:
            - Id:
                Name: '{{ Name }}'
          RequiredFields:
            - Id: null
          ReadOnlyFields:
            - Id: null
      - name: Defaults
        value:
          - Id: null
            DefaultValue: '{{ DefaultValue }}'
      - name: Fields
        value:
          - Id: null
            Description: '{{ Description }}'
            Type: '{{ Type }}'
            SingleSelectOptions:
              - '{{ SingleSelectOptions[0] }}'
      - name: Status
        value: '{{ Status }}'
      - name: ClientToken
        value: '{{ ClientToken }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.connect.task_templates
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

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

Create

connect:CreateTaskTemplate,
connect:TagResource

Read

connect:GetTaskTemplate

List

connect:ListTaskTemplates

Update

connect:UpdateTaskTemplate,
connect:TagResource,
connect:UntagResource

Delete

connect:DeleteTaskTemplate,
connect:UntagResource,
connect:GetTaskTemplate