This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::Connect::ContactFlow
<a name="aws-resource-connect-contactflow"></a>

Specifies a flow for an Amazon Connect instance.

## Syntax
<a name="aws-resource-connect-contactflow-syntax"></a>

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

### JSON
<a name="aws-resource-connect-contactflow-syntax.json"></a>

```
{
  "Type" : "AWS::Connect::ContactFlow",
  "Properties" : {
      "[Content](#cfn-connect-contactflow-content)" : String,
      "[Description](#cfn-connect-contactflow-description)" : String,
      "[InstanceArn](#cfn-connect-contactflow-instancearn)" : String,
      "[Name](#cfn-connect-contactflow-name)" : String,
      "[State](#cfn-connect-contactflow-state)" : String,
      "[Tags](#cfn-connect-contactflow-tags)" : [ Tag, ... ],
      "[Type](#cfn-connect-contactflow-type)" : String
    }
}
```

### YAML
<a name="aws-resource-connect-contactflow-syntax.yaml"></a>

```
Type: AWS::Connect::ContactFlow
Properties:
  [Content](#cfn-connect-contactflow-content): String
  [Description](#cfn-connect-contactflow-description): String
  [InstanceArn](#cfn-connect-contactflow-instancearn): String
  [Name](#cfn-connect-contactflow-name): String
  [State](#cfn-connect-contactflow-state): String
  [Tags](#cfn-connect-contactflow-tags): 
    - Tag
  [Type](#cfn-connect-contactflow-type): String
```

## Properties
<a name="aws-resource-connect-contactflow-properties"></a>

`Content`  <a name="cfn-connect-contactflow-content"></a>
The content of the flow.  
For more information, see [Amazon Connect Flow language](https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html) in the *Amazon Connect Administrator Guide*.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-connect-contactflow-description"></a>
The description of the flow.  
*Required*: No  
*Type*: String  
*Maximum*: `500`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InstanceArn`  <a name="cfn-connect-contactflow-instancearn"></a>
The Amazon Resource Name (ARN) of the Amazon Connect instance.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-connect-contactflow-name"></a>
The name of the flow.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `127`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`State`  <a name="cfn-connect-contactflow-state"></a>
The state of the flow.  
*Required*: No  
*Type*: String  
*Allowed values*: `ACTIVE | ARCHIVED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-connect-contactflow-tags"></a>
An array of key-value pairs to apply to this resource.  
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).  
*Required*: No  
*Type*: Array of [Tag](aws-properties-connect-contactflow-tag.md)  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-connect-contactflow-type"></a>
The type of the flow. For descriptions of the available types, see [Choose a flow type](https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types) in the *Amazon Connect Administrator Guide*.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `CONTACT_FLOW | CUSTOMER_QUEUE | CUSTOMER_HOLD | CUSTOMER_WHISPER | AGENT_HOLD | AGENT_WHISPER | OUTBOUND_WHISPER | AGENT_TRANSFER | QUEUE_TRANSFER | CAMPAIGN`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-connect-contactflow-return-values"></a>

### Ref
<a name="aws-resource-connect-contactflow-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the flow name. For example:

 `{ "Ref": "myFlowArn" }` 

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-connect-contactflow-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic 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::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-connect-contactflow-return-values-fn--getatt-fn--getatt"></a>

`ContactFlowArn`  <a name="ContactFlowArn-fn::getatt"></a>
When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the flow.   
For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

## Examples
<a name="aws-resource-connect-contactflow--examples"></a>



### Specify a flow resource
<a name="aws-resource-connect-contactflow--examples--Specify_a_flow_resource"></a>

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

#### YAML
<a name="aws-resource-connect-contactflow--examples--Specify_a_flow_resource--yaml"></a>

```
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
```