AWS::Connect::TaskTemplate

Specifies a task template for a Amazon Connect instance.

Syntax

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

JSON

{
  "Type" : "AWS::Connect::TaskTemplate",
  "Properties" : {
      "ClientToken" : String,
      "Constraints" : Constraints,
      "ContactFlowArn" : String,
      "Defaults" : [ DefaultFieldValue, ... ],
      "Description" : String,
      "Fields" : [ Field, ... ],
      "InstanceArn" : String,
      "Name" : String,
      "SelfAssignContactFlowArn" : String,
      "Status" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Connect::TaskTemplate
Properties:
  ClientToken: String
  Constraints: 
    Constraints
  ContactFlowArn: String
  Defaults: 
    - DefaultFieldValue
  Description: String
  Fields: 
    - Field
  InstanceArn: String
  Name: String
  SelfAssignContactFlowArn: String
  Status: String
  Tags: 
    - Tag

Properties

ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Required: No

Type: String

Pattern: ^$|[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$

Update requires: No interruption

Constraints

Constraints that are applicable to the fields listed.

The values can be represented in either JSON or YAML format. For an example of the JSON configuration, see Examples at the bottom of this page.

Required: No

Type: Constraints

Update requires: No interruption

ContactFlowArn

The Amazon Resource Name (ARN) of the flow that runs by default when a task is created by referencing this template. ContactFlowArn is not required when there is a field with fieldType = QUICK_CONNECT.

Required: No

Type: String

Pattern: ^$|arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/contact-flow/[-a-zA-Z0-9]*$

Update requires: No interruption

Defaults

The default values for fields when a task is created by referencing this template.

Required: No

Type: Array of DefaultFieldValue

Maximum: 50

Update requires: No interruption

Description

The description of the task template.

Required: No

Type: String

Minimum: 0

Maximum: 255

Update requires: No interruption

Fields

Fields that are part of the template. A template requires at least one field that has type Name.

Required: No

Type: Array of Field

Maximum: 50

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]*$

Update requires: No interruption

Name

The name of the task template.

Required: No

Type: String

Minimum: 1

Maximum: 100

Update requires: No interruption

SelfAssignContactFlowArn

The Amazon Resource Name (ARN) of the flow.

Required: No

Type: String

Pattern: ^$|arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/contact-flow/[-a-zA-Z0-9]*$

Update requires: No interruption

Status

The status of the task template.

Required: No

Type: String

Allowed values: ACTIVE | INACTIVE

Update requires: No interruption

Tags

The tags used to organize, track, or control access for this resource.

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 task template. For example:

{ "Ref": "myTaskTemplate" }

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.

Arn

The Amazon Resource Name (ARN) of the task template.

Examples

JSON format for Constraints

Following is an example of the JSON format for the Constraints property.

JSON

{
  "Type" : "AWS::Connect::TaskTemplate",
  "Properties" : {
      "ClientToken" : String,
      "Constraints" : Constraints,
      "ContactFlowArn" : String,
      "Defaults" : [ DefaultFieldValue, ... ],
      "Description" : String,
      "Fields" : [ Field, ... ],
      "InstanceArn" : String,
      "Name" : String,
      "Status" : String,
      "Tags" : [ Tag, ... ]
    }
}