CfnTaskTemplateProps

class aws_cdk.aws_connect.CfnTaskTemplateProps(*, instance_arn, client_token=None, constraints=None, contact_flow_arn=None, defaults=None, description=None, fields=None, name=None, status=None, tags=None)

Bases: object

Properties for defining a CfnTaskTemplate.

Parameters
  • instance_arn (str) – The Amazon Resource Name (ARN) of the Amazon Connect instance.

  • client_token (Optional[str]) – A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

  • constraints (Optional[Any]) – 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.

  • contact_flow_arn (Optional[str]) – 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 (Union[IResolvable, Sequence[Union[IResolvable, DefaultFieldValueProperty, Dict[str, Any]]], None]) – The default values for fields when a task is created by referencing this template.

  • description (Optional[str]) – The description of the task template.

  • fields (Union[IResolvable, Sequence[Union[IResolvable, FieldProperty, Dict[str, Any]]], None]) – Fields that are part of the template. A template requires at least one field that has type Name .

  • name (Optional[str]) – The name of the task template.

  • status (Optional[str]) – The status of the task template.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags used to organize, track, or control access for this resource.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-tasktemplate.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_connect as connect

# constraints: Any

cfn_task_template_props = connect.CfnTaskTemplateProps(
    instance_arn="instanceArn",

    # the properties below are optional
    client_token="clientToken",
    constraints=constraints,
    contact_flow_arn="contactFlowArn",
    defaults=[connect.CfnTaskTemplate.DefaultFieldValueProperty(
        default_value="defaultValue",
        id=connect.CfnTaskTemplate.FieldIdentifierProperty(
            name="name"
        )
    )],
    description="description",
    fields=[connect.CfnTaskTemplate.FieldProperty(
        id=connect.CfnTaskTemplate.FieldIdentifierProperty(
            name="name"
        ),
        type="type",

        # the properties below are optional
        description="description",
        single_select_options=["singleSelectOptions"]
    )],
    name="name",
    status="status",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

client_token

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-tasktemplate.html#cfn-connect-tasktemplate-clienttoken

Return type

Optional[str]

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-tasktemplate.html#cfn-connect-tasktemplate-constraints

Return type

Any

contact_flow_arn

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-tasktemplate.html#cfn-connect-tasktemplate-contactflowarn

Return type

Optional[str]

defaults

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-tasktemplate.html#cfn-connect-tasktemplate-defaults

Return type

Union[IResolvable, List[Union[IResolvable, DefaultFieldValueProperty]], None]

description

The description of the task template.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-tasktemplate.html#cfn-connect-tasktemplate-description

Return type

Optional[str]

fields

Fields that are part of the template.

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-tasktemplate.html#cfn-connect-tasktemplate-fields

Return type

Union[IResolvable, List[Union[IResolvable, FieldProperty]], None]

instance_arn

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-tasktemplate.html#cfn-connect-tasktemplate-instancearn

Return type

str

name

The name of the task template.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-tasktemplate.html#cfn-connect-tasktemplate-name

Return type

Optional[str]

status

The status of the task template.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-tasktemplate.html#cfn-connect-tasktemplate-status

Return type

Optional[str]

tags

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-tasktemplate.html#cfn-connect-tasktemplate-tags

Return type

Optional[List[CfnTag]]