CfnTaskTemplatePropsMixin

class aws_cdk.mixins_preview.aws_connect.mixins.CfnTaskTemplatePropsMixin(props, *, strategy=None)

Bases: Mixin

Specifies a task template for a Amazon Connect instance.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-tasktemplate.html
CloudformationResource:: AWS::Connect::TaskTemplate
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

# constraints: Any

cfn_task_template_props_mixin = connect_mixins.CfnTaskTemplatePropsMixin(connect_mixins.CfnTaskTemplateMixinProps(
    client_token="clientToken",
    constraints=constraints,
    contact_flow_arn="contactFlowArn",
    defaults=[connect_mixins.CfnTaskTemplatePropsMixin.DefaultFieldValueProperty(
        default_value="defaultValue",
        id=connect_mixins.CfnTaskTemplatePropsMixin.FieldIdentifierProperty(
            name="name"
        )
    )],
    description="description",
    fields=[connect_mixins.CfnTaskTemplatePropsMixin.FieldProperty(
        description="description",
        id=connect_mixins.CfnTaskTemplatePropsMixin.FieldIdentifierProperty(
            name="name"
        ),
        single_select_options=["singleSelectOptions"],
        type="type"
    )],
    instance_arn="instanceArn",
    name="name",
    self_assign_contact_flow_arn="selfAssignContactFlowArn",
    status="status",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Connect::TaskTemplate.

Parameters:

props (Union[CfnTaskTemplateMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['clientToken', 'constraints', 'contactFlowArn', 'defaults', 'description', 'fields', 'instanceArn', 'name', 'selfAssignContactFlowArn', 'status', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ConstraintsProperty

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

Bases: object

Describes constraints that apply to the template fields.

Parameters:

invisible_fields (Union[IResolvable, Sequence[Union[IResolvable, InvisibleFieldInfoProperty, Dict[str, Any]]], None]) – Lists the fields that are invisible to agents.
read_only_fields (Union[IResolvable, Sequence[Union[IResolvable, ReadOnlyFieldInfoProperty, Dict[str, Any]]], None]) – Lists the fields that are read-only to agents, and cannot be edited.
required_fields (Union[IResolvable, Sequence[Union[IResolvable, RequiredFieldInfoProperty, Dict[str, Any]]], None]) – Lists the fields that are required to be filled by agents.

See:

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.
from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins

constraints_property = connect_mixins.CfnTaskTemplatePropsMixin.ConstraintsProperty(
    invisible_fields=[connect_mixins.CfnTaskTemplatePropsMixin.InvisibleFieldInfoProperty(
        id=connect_mixins.CfnTaskTemplatePropsMixin.FieldIdentifierProperty(
            name="name"
        )
    )],
    read_only_fields=[connect_mixins.CfnTaskTemplatePropsMixin.ReadOnlyFieldInfoProperty(
        id=connect_mixins.CfnTaskTemplatePropsMixin.FieldIdentifierProperty(
            name="name"
        )
    )],
    required_fields=[connect_mixins.CfnTaskTemplatePropsMixin.RequiredFieldInfoProperty(
        id=connect_mixins.CfnTaskTemplatePropsMixin.FieldIdentifierProperty(
            name="name"
        )
    )]
)

Attributes

invisible_fields

Lists the fields that are invisible to agents.

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

read_only_fields

Lists the fields that are read-only to agents, and cannot be edited.

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

required_fields

Lists the fields that are required to be filled by agents.

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

DefaultFieldValueProperty

class CfnTaskTemplatePropsMixin.DefaultFieldValueProperty(*, default_value=None, id=None)

Bases: object

Describes a default field and its corresponding value.

Parameters:

default_value (Optional[str]) – Default value for the field.
id (Union[IResolvable, FieldIdentifierProperty, Dict[str, Any], None]) – Identifier of a field.

See:

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.
from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins

default_field_value_property = connect_mixins.CfnTaskTemplatePropsMixin.DefaultFieldValueProperty(
    default_value="defaultValue",
    id=connect_mixins.CfnTaskTemplatePropsMixin.FieldIdentifierProperty(
        name="name"
    )
)

Attributes

default_value

Default value for the field.

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

id

Identifier of a field.

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

FieldIdentifierProperty

class CfnTaskTemplatePropsMixin.FieldIdentifierProperty(*, name=None)

Bases: object

The identifier of the task template field.

Parameters:: name (Optional[str]) – The name of the task template field.
See:: 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.
from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins

field_identifier_property = connect_mixins.CfnTaskTemplatePropsMixin.FieldIdentifierProperty(
    name="name"
)

Attributes

name

The name of the task template field.

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

FieldProperty

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

Bases: object

Describes a single task template field.

Parameters:

description (Optional[str]) – The description of the field.
id (Union[IResolvable, FieldIdentifierProperty, Dict[str, Any], None]) – The unique identifier for the field.
single_select_options (Optional[Sequence[str]]) – A list of options for a single select field.
type (Optional[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

See:

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.
from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins

field_property = connect_mixins.CfnTaskTemplatePropsMixin.FieldProperty(
    description="description",
    id=connect_mixins.CfnTaskTemplatePropsMixin.FieldIdentifierProperty(
        name="name"
    ),
    single_select_options=["singleSelectOptions"],
    type="type"
)

Attributes

description

The description of the field.

See:: 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.

See:: 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.

See:: 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.

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

InvisibleFieldInfoProperty

class CfnTaskTemplatePropsMixin.InvisibleFieldInfoProperty(*, id=None)

Bases: object

A field that is invisible to an agent.

Parameters:: id (Union[IResolvable, FieldIdentifierProperty, Dict[str, Any], None]) – Identifier of the invisible field.
See:: 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.
from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins

invisible_field_info_property = connect_mixins.CfnTaskTemplatePropsMixin.InvisibleFieldInfoProperty(
    id=connect_mixins.CfnTaskTemplatePropsMixin.FieldIdentifierProperty(
        name="name"
    )
)

Attributes

id

Identifier of the invisible field.

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

ReadOnlyFieldInfoProperty

class CfnTaskTemplatePropsMixin.ReadOnlyFieldInfoProperty(*, id=None)

Bases: object

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

Parameters:: id (Union[IResolvable, FieldIdentifierProperty, Dict[str, Any], None]) – Identifier of the read-only field.
See:: 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.
from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins

read_only_field_info_property = connect_mixins.CfnTaskTemplatePropsMixin.ReadOnlyFieldInfoProperty(
    id=connect_mixins.CfnTaskTemplatePropsMixin.FieldIdentifierProperty(
        name="name"
    )
)

Attributes

id

Identifier of the read-only field.

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

RequiredFieldInfoProperty

class CfnTaskTemplatePropsMixin.RequiredFieldInfoProperty(*, id=None)

Bases: object

Information about a required field.

Parameters:: id (Union[IResolvable, FieldIdentifierProperty, Dict[str, Any], None]) – The unique identifier for the field.
See:: 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.
from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins

required_field_info_property = connect_mixins.CfnTaskTemplatePropsMixin.RequiredFieldInfoProperty(
    id=connect_mixins.CfnTaskTemplatePropsMixin.FieldIdentifierProperty(
        name="name"
    )
)

Attributes

id

The unique identifier for the field.

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