AWS::Connect::ContactFlowModule - 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::ContactFlowModule

Specifies a flow module for an Amazon Connect instance.

Syntax

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

JSON

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

YAML

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

Properties

Content

The content of the flow module.

Required: Yes

Type: String

Minimum: 1

Maximum: 256000

Update requires: No interruption

Description

The description of the flow module.

Required: No

Type: String

Pattern: .*\S.*

Maximum: 500

Update requires: No interruption

InstanceArn

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

Name

The name of the flow module.

Required: Yes

Type: String

Pattern: .*\S.*

Minimum: 1

Maximum: 127

Update requires: No interruption

State

The state of the flow module.

Required: No

Type: String

Maximum: 500

Update requires: No interruption

Tags

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

For more information, see Tag.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

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

{ "Ref": "myFlowModuleName" }

For more information about using the Ref function, see Ref.

Fn::GetAtt

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 Fn::GetAtt.

ContactFlowModuleArn

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Amazon Resource Name (ARN) of the flow module. For example:

{ "Ref": "myFlowModuleArn" }

For more information about using the Ref function, see Ref.

Status

Examples

Specify a flow module resource

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

YAML

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