contact_flows

Creates, updates, deletes or gets a contact_flow resource or lists contact_flows in a region

Overview

Name	contact_flows
Type	Resource
Description	Resource Type definition for AWS::Connect::ContactFlow
Id	aws.connect.contact_flows

Fields

Name	Datatype	Description
instance_arn	string	The identifier of the Amazon Connect instance (ARN).
contact_flow_arn	string	The identifier of the contact flow (ARN).
name	string	The name of the contact flow.
content	string	The content of the contact flow in JSON format.
description	string	The description of the contact flow.
state	string	The state of the contact flow.
type	string	The type of the contact flow.
tags	array	One or more tags.
region	string	AWS region.

Methods

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

SELECT
region,
instance_arn,
contact_flow_arn,
name,
content,
description,
state,
type,
tags
FROM aws.connect.contact_flows
WHERE region = 'us-east-1';

Gets all properties from an individual contact_flow.

SELECT
region,
instance_arn,
contact_flow_arn,
name,
content,
description,
state,
type,
tags
FROM aws.connect.contact_flows
WHERE region = 'us-east-1' AND data__Identifier = '<ContactFlowArn>';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO aws.connect.contact_flows (
 InstanceArn,
 Name,
 Content,
 Description,
 State,
 Type,
 Tags,
 region
)
SELECT 
 '{{ InstanceArn }}',
 '{{ Name }}',
 '{{ Content }}',
 '{{ Description }}',
 '{{ State }}',
 '{{ Type }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: contact_flow
    props:
      - name: InstanceArn
        value: '{{ InstanceArn }}'
      - name: Name
        value: '{{ Name }}'
      - name: Content
        value: '{{ Content }}'
      - name: Description
        value: '{{ Description }}'
      - name: State
        value: '{{ State }}'
      - name: Type
        value: '{{ Type }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

connect:CreateContactFlow,
connect:TagResource

Read

connect:DescribeContactFlow

Delete

connect:DeleteContactFlow,
connect:UntagResource

Update

connect:UpdateContactFlowMetadata,
connect:UpdateContactFlowContent,
connect:TagResource,
connect:UntagResource

List

connect:ListContactFlows