quick_connects

Creates, updates, deletes or gets a quick_connect resource or lists quick_connects in a region

Overview

Name	quick_connects
Type	Resource
Description	Resource Type definition for AWS::Connect::QuickConnect
Id	aws.connect.quick_connects

Fields

Name	Datatype	Description
instance_arn	string	The identifier of the Amazon Connect instance.
name	string	The name of the quick connect.
description	string	The description of the quick connect.
quick_connect_config	object	Configuration settings for the quick connect.
quick_connect_arn	string	The Amazon Resource Name (ARN) for the quick connect.
tags	array	One or more tags.
quick_connect_type	string	The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
region	string	AWS region.

Methods

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

SELECT
region,
instance_arn,
name,
description,
quick_connect_config,
quick_connect_arn,
tags,
quick_connect_type
FROM aws.connect.quick_connects
WHERE region = 'us-east-1';

Gets all properties from an individual quick_connect.

SELECT
region,
instance_arn,
name,
description,
quick_connect_config,
quick_connect_arn,
tags,
quick_connect_type
FROM aws.connect.quick_connects
WHERE region = 'us-east-1' AND data__Identifier = '<QuickConnectArn>';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO aws.connect.quick_connects (
 InstanceArn,
 Name,
 Description,
 QuickConnectConfig,
 Tags,
 region
)
SELECT 
 '{{ InstanceArn }}',
 '{{ Name }}',
 '{{ Description }}',
 '{{ QuickConnectConfig }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: quick_connect
    props:
      - name: InstanceArn
        value: '{{ InstanceArn }}'
      - name: Name
        value: '{{ Name }}'
      - name: Description
        value: '{{ Description }}'
      - name: QuickConnectConfig
        value:
          QuickConnectType: '{{ QuickConnectType }}'
          PhoneConfig:
            PhoneNumber: '{{ PhoneNumber }}'
          QueueConfig:
            ContactFlowArn: '{{ ContactFlowArn }}'
            QueueArn: '{{ QueueArn }}'
          UserConfig:
            ContactFlowArn: null
            UserArn: '{{ UserArn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

connect:CreateQuickConnect,
connect:TagResource

Read

connect:DescribeQuickConnect

Delete

connect:DeleteQuickConnect,
connect:UntagResource

Update

connect:UpdateQuickConnectName,
connect:UpdateQuickConnectConfig,
connect:TagResource,
connect:UntagResource

List

connect:ListQuickConnects