contact_flow_modules

Creates, updates, deletes or gets a contact_flow_module resource or lists contact_flow_modules in a region

Overview

Name	contact_flow_modules
Type	Resource
Description	Resource Type definition for AWS::Connect::ContactFlowModule.
Id	aws.connect.contact_flow_modules

Fields

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

Methods

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

SELECT
region,
instance_arn,
contact_flow_module_arn,
name,
content,
description,
state,
status,
tags
FROM aws.connect.contact_flow_modules
WHERE region = 'us-east-1';

Gets all properties from an individual contact_flow_module.

SELECT
region,
instance_arn,
contact_flow_module_arn,
name,
content,
description,
state,
status,
tags
FROM aws.connect.contact_flow_modules
WHERE region = 'us-east-1' AND data__Identifier = '<ContactFlowModuleArn>';

INSERT example

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

Required Properties

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

All Properties

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

Manifest

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

DELETE example

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

Permissions

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

Create

connect:CreateContactFlowModule,
connect:TagResource

Read

connect:DescribeContactFlowModule

Delete

connect:DeleteContactFlowModule,
connect:UntagResource

Update

connect:UpdateContactFlowModuleMetadata,
connect:UpdateContactFlowModuleContent,
connect:TagResource,
connect:UntagResource

List

connect:ListContactFlowModules