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	awscc.connect.quick_connects

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
quick_connect_arn	string	The Amazon Resource Name (ARN) for the quick connect.
region	string	AWS region.

For more information, see AWS::Connect::QuickConnect.

Methods

Name	Resource	Accessible by	Required Params
create_resource	quick_connects	INSERT	Name, InstanceArn, QuickConnectConfig, region
delete_resource	quick_connects	DELETE	Identifier, region
update_resource	quick_connects	UPDATE	Identifier, PatchDocument, region
list_resources	quick_connects_list_only	SELECT	region
get_resource	quick_connects	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.connect.quick_connects
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ quick_connect_arn }}';

list (identifiers only)

Lists all quick_connects in a region.

SELECT
  region,
  quick_connect_arn
FROM awscc.connect.quick_connects_list_only
WHERE
  region = '{{ region }}';

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 awscc.connect.quick_connects (
  InstanceArn,
  Name,
  QuickConnectConfig,
  region
)
SELECT
  '{{ instance_arn }}',
  '{{ name }}',
  '{{ quick_connect_config }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.connect.quick_connects (
  InstanceArn,
  Name,
  Description,
  QuickConnectConfig,
  Tags,
  region
)
SELECT
  '{{ instance_arn }}',
  '{{ name }}',
  '{{ description }}',
  '{{ quick_connect_config }}',
  '{{ tags }}',
  '{{ 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: quick_connect
  props:
    - name: instance_arn
      value: '{{ instance_arn }}'
    - name: name
      value: '{{ name }}'
    - name: description
      value: '{{ description }}'
    - name: quick_connect_config
      value:
        quick_connect_type: '{{ quick_connect_type }}'
        phone_config:
          phone_number: '{{ phone_number }}'
        queue_config:
          contact_flow_arn: '{{ contact_flow_arn }}'
          queue_arn: '{{ queue_arn }}'
        user_config:
          contact_flow_arn: null
          user_arn: '{{ user_arn }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.connect.quick_connects
SET PatchDocument = string('{{ {
    "InstanceArn": instance_arn,
    "Name": name,
    "Description": description,
    "QuickConnectConfig": quick_connect_config,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ quick_connect_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.connect.quick_connects
WHERE
  Identifier = '{{ quick_connect_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 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