CfnTaskTemplate

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

Bases: CfnResource

A CloudFormation AWS::Connect::TaskTemplate.

Specifies a task template for a Amazon Connect instance.

CloudformationResource

AWS::Connect::TaskTemplate

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 = connect.CfnTaskTemplate(self, "MyCfnTaskTemplate",
    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"
    )]
)

Create a new AWS::Connect::TaskTemplate.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • 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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

Return type

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

Return type

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Connect::TaskTemplate'
attr_arn

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

CloudformationAttribute

Arn

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

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

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

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

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

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

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

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

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

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

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

node

The construct tree node associated with this construct.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

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

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

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

ConstraintsProperty

class CfnTaskTemplate.ConstraintsProperty(*, invisible_fields=None, read_only_fields=None, required_fields=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-constraints.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_property = connect.CfnTaskTemplate.ConstraintsProperty(
    invisible_fields=[connect.CfnTaskTemplate.InvisibleFieldInfoProperty(
        id=connect.CfnTaskTemplate.FieldIdentifierProperty(
            name="name"
        )
    )],
    read_only_fields=[connect.CfnTaskTemplate.ReadOnlyFieldInfoProperty(
        id=connect.CfnTaskTemplate.FieldIdentifierProperty(
            name="name"
        )
    )],
    required_fields=[connect.CfnTaskTemplate.RequiredFieldInfoProperty(
        id=connect.CfnTaskTemplate.FieldIdentifierProperty(
            name="name"
        )
    )]
)

Attributes

invisible_fields

CfnTaskTemplate.ConstraintsProperty.InvisibleFields.

Link

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

read_only_fields

CfnTaskTemplate.ConstraintsProperty.ReadOnlyFields.

Link

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

required_fields

CfnTaskTemplate.ConstraintsProperty.RequiredFields.

Link

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

DefaultFieldValueProperty

class CfnTaskTemplate.DefaultFieldValueProperty(*, default_value, id)

Bases: object

Describes a default field and its corresponding value.

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-defaultfieldvalue.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

default_field_value_property = connect.CfnTaskTemplate.DefaultFieldValueProperty(
    default_value="defaultValue",
    id=connect.CfnTaskTemplate.FieldIdentifierProperty(
        name="name"
    )
)

Attributes

default_value

Default value for the field.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-defaultfieldvalue.html#cfn-connect-tasktemplate-defaultfieldvalue-defaultvalue

id

Identifier of a field.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-defaultfieldvalue.html#cfn-connect-tasktemplate-defaultfieldvalue-id

FieldIdentifierProperty

class CfnTaskTemplate.FieldIdentifierProperty(*, name)

Bases: object

The identifier of the task template field.

Parameters

name (str) – The name of the task template field.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-fieldidentifier.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

field_identifier_property = connect.CfnTaskTemplate.FieldIdentifierProperty(
    name="name"
)

Attributes

name

The name of the task template field.

Link

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

FieldProperty

class CfnTaskTemplate.FieldProperty(*, id, type, description=None, single_select_options=None)

Bases: object

Describes a single task template field.

Parameters
  • id (Union[IResolvable, FieldIdentifierProperty, Dict[str, Any]]) – The unique identifier for the field.

  • type (str) – Indicates the type of field. Following are the valid field types: NAME DESCRIPTION | SCHEDULED_TIME | QUICK_CONNECT | URL | NUMBER | TEXT | TEXT_AREA | DATE_TIME | BOOLEAN | SINGLE_SELECT | EMAIL

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

  • single_select_options (Optional[Sequence[str]]) – A list of options for a single select field.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-field.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

field_property = connect.CfnTaskTemplate.FieldProperty(
    id=connect.CfnTaskTemplate.FieldIdentifierProperty(
        name="name"
    ),
    type="type",

    # the properties below are optional
    description="description",
    single_select_options=["singleSelectOptions"]
)

Attributes

description

The description of the field.

Link

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

id

The unique identifier for the field.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-field.html#cfn-connect-tasktemplate-field-id

single_select_options

A list of options for a single select field.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-field.html#cfn-connect-tasktemplate-field-singleselectoptions

type

Indicates the type of field.

Following are the valid field types: NAME DESCRIPTION | SCHEDULED_TIME | QUICK_CONNECT | URL | NUMBER | TEXT | TEXT_AREA | DATE_TIME | BOOLEAN | SINGLE_SELECT | EMAIL

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-field.html#cfn-connect-tasktemplate-field-type

InvisibleFieldInfoProperty

class CfnTaskTemplate.InvisibleFieldInfoProperty(*, id)

Bases: object

A field that is invisible to an agent.

Parameters

id (Union[IResolvable, FieldIdentifierProperty, Dict[str, Any]]) – Identifier of the invisible field.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-invisiblefieldinfo.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

invisible_field_info_property = connect.CfnTaskTemplate.InvisibleFieldInfoProperty(
    id=connect.CfnTaskTemplate.FieldIdentifierProperty(
        name="name"
    )
)

Attributes

id

Identifier of the invisible field.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-invisiblefieldinfo.html#cfn-connect-tasktemplate-invisiblefieldinfo-id

ReadOnlyFieldInfoProperty

class CfnTaskTemplate.ReadOnlyFieldInfoProperty(*, id)

Bases: object

Indicates a field that is read-only to an agent.

Parameters

id (Union[IResolvable, FieldIdentifierProperty, Dict[str, Any]]) – Identifier of the read-only field.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-readonlyfieldinfo.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

read_only_field_info_property = connect.CfnTaskTemplate.ReadOnlyFieldInfoProperty(
    id=connect.CfnTaskTemplate.FieldIdentifierProperty(
        name="name"
    )
)

Attributes

id

Identifier of the read-only field.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-readonlyfieldinfo.html#cfn-connect-tasktemplate-readonlyfieldinfo-id

RequiredFieldInfoProperty

class CfnTaskTemplate.RequiredFieldInfoProperty(*, id)

Bases: object

Information about a required field.

Parameters

id (Union[IResolvable, FieldIdentifierProperty, Dict[str, Any]]) – The unique identifier for the field.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-requiredfieldinfo.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

required_field_info_property = connect.CfnTaskTemplate.RequiredFieldInfoProperty(
    id=connect.CfnTaskTemplate.FieldIdentifierProperty(
        name="name"
    )
)

Attributes

id

The unique identifier for the field.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-requiredfieldinfo.html#cfn-connect-tasktemplate-requiredfieldinfo-id