AWS::Connect::ContactFlow - Amazon CloudFormation
SyntaxPropertiesReturn valuesExamples
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Connect::ContactFlow

Specifies a flow for an Amazon Connect instance.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Connect::ContactFlow",
  "Properties" : {
      "Content" : String,
      "Description" : String,
      "InstanceArn" : String,
      "Name" : String,
      "State" : String,
      "Tags" : [ Tag, ... ],
      "Type" : String
    }
}

YAML

Type: AWS::Connect::ContactFlow
Properties: 
  Content: String
  Description: String
  InstanceArn: String
  Name: String
  State: String
  Tags: 
    - Tag
  Type: String

Properties

Content

The content of the flow.

For more information, see Amazon Connect Flow language in the Amazon Connect Administrator Guide.

Required: Yes

Type: String

Update requires: No interruption

Description

The description of the flow.

Required: No

Type: String

Update requires: No interruption

InstanceArn

The Amazon Resource Name (ARN) of the Amazon Connect instance.

Required: Yes

Type: String

Update requires: No interruption

Name

The name of the flow.

Required: Yes

Type: String

Minimum: 1

Update requires: No interruption

State

The state of the flow.

Required: No

Type: String

Allowed values: ACTIVE | ARCHIVED

Update requires: No interruption

Tags

An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: List of Tag

Update requires: No interruption

Type

The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.

Required: Yes

Type: String

Allowed values: AGENT_HOLD | AGENT_TRANSFER | AGENT_WHISPER | CONTACT_FLOW | CUSTOMER_HOLD | CUSTOMER_QUEUE | CUSTOMER_WHISPER | OUTBOUND_WHISPER | QUEUE_TRANSFER

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Reffunction, Refreturns the flow name. For example:

{ "Ref": "myFlowName" }

For more information about using the Reffunction, see Ref.

Fn::GetAtt

The Fn::GetAttintrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAttintrinsic function, see Fn::GetAtt.

ContactFlowArn

When you pass the logical ID of this resource to the intrinsic Reffunction, Refreturns the Amazon Resource Name (ARN) of the flow. For example:

{ "Ref": "myFlowArn" }

For more information about using the Reffunction, see Ref.

Examples

Specify a flow resource

The following example specifies a flow resource for an Amazon Connect instance.

YAML

AWSTemplateFormatVersion: 2010-09-09
Description: Specifies a flow for an Amazon Connect instance
Resources:
  Flow:
    Type: 'AWS::Connect::ContactFlow'
    Properties:
      Name: ExampleFlow
      Description: flow created using cfn
      InstanceArn: arn:aws:connect:region-name:aws-account-id:instance/instance-arn
      Type: CONTACT_FLOW
      Content: ExampleFlow content(JSON) using Amazon Connect Flow Language.
      Tags:
        - Key: testkey
          Value: testValue