AWS Amazon Connect Contact Flow

This page shows how to write Terraform and CloudFormation for Amazon Connect Contact Flow and write them securely.

aws_connect_contact_flow (Terraform)

The Contact Flow in Amazon Connect can be configured in Terraform with the resource name aws_connect_contact_flow. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Review your Terraform file for AWS best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

The following arguments are supported:

  • content - (Optional) Specifies the content of the Contact Flow, provided as a JSON string, written in Amazon Connect Contact Flow Language. If defined, the filename argument cannot be used.
  • content_hash - (Optional) Used to trigger updates. Must be set to a base64-encoded SHA256 hash of the Contact Flow source specified with filename. The usual way to set this is filebase64sha256("mycontact_flow.json") (Terraform 0.11.12 and later) or base64sha256(file("mycontact_flow.json")) (Terraform 0.11.11 and earlier), where "mycontact_flow.json" is the local filename of the Contact Flow source.
  • description - (Optional) Specifies the description of the Contact Flow.
  • filename - (Optional) The path to the Contact Flow source within the local filesystem. Conflicts with content.
  • instance_id - (Required) Specifies the identifier of the hosting Amazon Connect Instance.
  • name - (Required) Specifies the name of the Contact Flow.
  • tags - (Optional) Tags to apply to the Contact Flow. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
  • type - (Optional) Specifies the type of the Contact Flow. Defaults to CONTACT_FLOW. Allowed Values are: CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER.

In addition to all arguments above, the following attributes are exported:

  • arn - The Amazon Resource Name (ARN) of the Contact Flow.
  • id - The identifier of the hosting Amazon Connect Instance and identifier of the Contact Flow separated by a colon (:).
  • contact_flow_id - The identifier of the Contact Flow.
  • tags_all - A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Explanation in Terraform Registry

Provides an Amazon Connect Contact Flow resource. For more information see Amazon Connect: Getting Started This resource embeds or references Contact Flows specified in Amazon Connect Contact Flow Language. For more information see Amazon Connect Flow language !> WARN: Contact Flows exported from the Console Contact Flow import/export are not in the Amazon Connect Contact Flow Language and can not be used with this resource. Instead, the recommendation is to use the AWS CLI describe-contact-flow. See example below which uses jq to extract the Content attribute and saves it to a local file.

NOTE: Due to The behaviour of Amazon Connect you cannot delete contact flows. The recommendation is to prefix the Contact Flow with zzTrash_ to get obsolete contact flows out of the way.

AWS::Connect::HoursOfOperation (CloudFormation)

The HoursOfOperation in Connect can be configured in CloudFormation with the resource name AWS::Connect::HoursOfOperation. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Parameters

Config Configuration information for the hours of operation.
Required: Yes
Type: List of HoursOfOperationConfig
Maximum: 100
Update requires: No interruption

Description The description for the hours of operation.
Required: No
Type: String
Minimum: 1
Maximum: 250
Update requires: No interruption

InstanceArn The Amazon Resource Name (ARN) for the instance.
Required: Yes
Type: String
Update requires: No interruption

Name The name for the hours of operation.
Required: Yes
Type: String
Minimum: 1
Maximum: 127
Update requires: No interruption

Tags One or more tags.
Required: No
Type: List of Tag
Update requires: No interruption

TimeZone The time zone for the hours of operation.
Required: Yes
Type: String
Update requires: No interruption

Explanation in CloudFormation Registry

Creates hours of operation.

Frequently asked questions

What is AWS Amazon Connect Contact Flow?

AWS Amazon Connect Contact Flow is a resource for Amazon Connect of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.