aws-cdk-lib.aws_connect.CfnTaskTemplateProps

interface CfnTaskTemplateProps

LanguageType name
.NETAmazon.CDK.AWS.Connect.CfnTaskTemplateProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsconnect#CfnTaskTemplateProps
Javasoftware.amazon.awscdk.services.connect.CfnTaskTemplateProps
Pythonaws_cdk.aws_connect.CfnTaskTemplateProps
TypeScript aws-cdk-lib » aws_connect » CfnTaskTemplateProps

Properties for defining a CfnTaskTemplate.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_connect as connect } from 'aws-cdk-lib';

declare const constraints: any;
const cfnTaskTemplateProps: connect.CfnTaskTemplateProps = {
  instanceArn: 'instanceArn',

  // the properties below are optional
  clientToken: 'clientToken',
  constraints: constraints,
  contactFlowArn: 'contactFlowArn',
  defaults: [{
    defaultValue: 'defaultValue',
    id: {
      name: 'name',
    },
  }],
  description: 'description',
  fields: [{
    id: {
      name: 'name',
    },
    type: 'type',

    // the properties below are optional
    description: 'description',
    singleSelectOptions: ['singleSelectOptions'],
  }],
  name: 'name',
  status: 'status',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
instanceArnstringThe Amazon Resource Name (ARN) of the Amazon Connect instance.
clientToken?stringA unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
constraints?anyConstraints that are applicable to the fields listed.
contactFlowArn?stringThe Amazon Resource Name (ARN) of the flow that runs by default when a task is created by referencing this template.
defaults?IResolvable | IResolvable | DefaultFieldValueProperty[]The default values for fields when a task is created by referencing this template.
description?stringThe description of the task template.
fields?IResolvable | IResolvable | FieldProperty[]Fields that are part of the template.
name?stringThe name of the task template.
status?stringThe status of the task template.
tags?CfnTag[]The tags used to organize, track, or control access for this resource.

instanceArn

Type: string

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


clientToken?

Type: string (optional)

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


constraints?

Type: any (optional)

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.


contactFlowArn?

Type: string (optional)

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 .


defaults?

Type: IResolvable | IResolvable | DefaultFieldValueProperty[] (optional)

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


description?

Type: string (optional)

The description of the task template.


fields?

Type: IResolvable | IResolvable | FieldProperty[] (optional)

Fields that are part of the template.

A template requires at least one field that has type Name .


name?

Type: string (optional)

The name of the task template.


status?

Type: string (optional)

The status of the task template.


tags?

Type: CfnTag[] (optional)

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