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

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
contact_flow_module_arn	string	The identifier of the contact flow module (ARN).
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	contact_flow_modules	INSERT	InstanceArn, Name, Content, region
delete_resource	contact_flow_modules	DELETE	Identifier, region
update_resource	contact_flow_modules	UPDATE	Identifier, PatchDocument, region
list_resources	contact_flow_modules_list_only	SELECT	region
get_resource	contact_flow_modules	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual contact_flow_module.

SELECT
  region,
  instance_arn,
  contact_flow_module_arn,
  name,
  content,
  description,
  state,
  status,
  tags
FROM awscc.connect.contact_flow_modules
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ contact_flow_module_arn }}';

list (identifiers only)

Lists all contact_flow_modules in a region.

SELECT
  region,
  contact_flow_module_arn
FROM awscc.connect.contact_flow_modules_list_only
WHERE
  region = '{{ region }}';

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

All Properties

/*+ create */
INSERT INTO awscc.connect.contact_flow_modules (
  InstanceArn,
  Name,
  Content,
  Description,
  State,
  Tags,
  region
)
SELECT
  '{{ instance_arn }}',
  '{{ name }}',
  '{{ content }}',
  '{{ description }}',
  '{{ state }}',
  '{{ 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: contact_flow_module
  props:
    - name: instance_arn
      value: '{{ instance_arn }}'
    - name: name
      value: '{{ name }}'
    - name: content
      value: '{{ content }}'
    - name: description
      value: '{{ description }}'
    - name: state
      value: '{{ state }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

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

DELETE example

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