Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. connect
  5. TaskTemplate

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.connect.TaskTemplate

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Connect::TaskTemplate.

    Create TaskTemplate Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new TaskTemplate(name: string, args: TaskTemplateArgs, opts?: CustomResourceOptions);
    @overload
def TaskTemplate(resource_name: str,
                 args: TaskTemplateArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def TaskTemplate(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 instance_arn: Optional[str] = None,
                 client_token: Optional[str] = None,
                 constraints: Optional[ConstraintsPropertiesArgs] = None,
                 contact_flow_arn: Optional[str] = None,
                 defaults: Optional[Sequence[TaskTemplateDefaultFieldValueArgs]] = None,
                 description: Optional[str] = None,
                 fields: Optional[Sequence[TaskTemplateFieldArgs]] = None,
                 name: Optional[str] = None,
                 status: Optional[TaskTemplateStatus] = None,
                 tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewTaskTemplate(ctx *Context, name string, args TaskTemplateArgs, opts ...ResourceOption) (*TaskTemplate, error)
    public TaskTemplate(string name, TaskTemplateArgs args, CustomResourceOptions? opts = null)
    public TaskTemplate(String name, TaskTemplateArgs args)
public TaskTemplate(String name, TaskTemplateArgs args, CustomResourceOptions options)

    type: aws-native:connect:TaskTemplate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args TaskTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args TaskTemplateArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args TaskTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TaskTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TaskTemplateArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    TaskTemplate Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The TaskTemplate resource accepts the following input properties:

    InstanceArn string
    The identifier (arn) of the instance.
    ClientToken string
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    Constraints Pulumi.AwsNative.Connect.Inputs.ConstraintsProperties
    The constraints for the task template
    ContactFlowArn string
    The identifier of the contact flow.
    Defaults List<Pulumi.AwsNative.Connect.Inputs.TaskTemplateDefaultFieldValue>
    The default values for fields when a task is created by referencing this template.
    Description string
    The description of the task template.
    Fields List<Pulumi.AwsNative.Connect.Inputs.TaskTemplateField>
    The list of task template's fields
    Name string
    The name of the task template.
    Status Pulumi.AwsNative.Connect.TaskTemplateStatus
    The status of the task template.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    One or more tags.
    InstanceArn string
    The identifier (arn) of the instance.
    ClientToken string
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    Constraints ConstraintsPropertiesArgs
    The constraints for the task template
    ContactFlowArn string
    The identifier of the contact flow.
    Defaults []TaskTemplateDefaultFieldValueArgs
    The default values for fields when a task is created by referencing this template.
    Description string
    The description of the task template.
    Fields []TaskTemplateFieldArgs
    The list of task template's fields
    Name string
    The name of the task template.
    Status TaskTemplateStatus
    The status of the task template.
    Tags TagArgs
    One or more tags.
    instanceArn String
    The identifier (arn) of the instance.
    clientToken String
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    constraints ConstraintsProperties
    The constraints for the task template
    contactFlowArn String
    The identifier of the contact flow.
    defaults List<TaskTemplateDefaultFieldValue>
    The default values for fields when a task is created by referencing this template.
    description String
    The description of the task template.
    fields List<TaskTemplateField>
    The list of task template's fields
    name String
    The name of the task template.
    status TaskTemplateStatus
    The status of the task template.
    tags List<Tag>
    One or more tags.
    instanceArn string
    The identifier (arn) of the instance.
    clientToken string
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    constraints ConstraintsProperties
    The constraints for the task template
    contactFlowArn string
    The identifier of the contact flow.
    defaults TaskTemplateDefaultFieldValue[]
    The default values for fields when a task is created by referencing this template.
    description string
    The description of the task template.
    fields TaskTemplateField[]
    The list of task template's fields
    name string
    The name of the task template.
    status TaskTemplateStatus
    The status of the task template.
    tags Tag[]
    One or more tags.
    instance_arn str
    The identifier (arn) of the instance.
    client_token str
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    constraints ConstraintsPropertiesArgs
    The constraints for the task template
    contact_flow_arn str
    The identifier of the contact flow.
    defaults Sequence[TaskTemplateDefaultFieldValueArgs]
    The default values for fields when a task is created by referencing this template.
    description str
    The description of the task template.
    fields Sequence[TaskTemplateFieldArgs]
    The list of task template's fields
    name str
    The name of the task template.
    status TaskTemplateStatus
    The status of the task template.
    tags Sequence[TagArgs]
    One or more tags.
    instanceArn String
    The identifier (arn) of the instance.
    clientToken String
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    constraints Property Map
    The constraints for the task template
    contactFlowArn String
    The identifier of the contact flow.
    defaults List<Property Map>
    The default values for fields when a task is created by referencing this template.
    description String
    The description of the task template.
    fields List<Property Map>
    The list of task template's fields
    name String
    The name of the task template.
    status "ACTIVE" | "INACTIVE"
    The status of the task template.
    tags List<Property Map>
    One or more tags.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TaskTemplate resource produces the following output properties:

    Arn string
    The identifier (arn) of the task template.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The identifier (arn) of the task template.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The identifier (arn) of the task template.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The identifier (arn) of the task template.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The identifier (arn) of the task template.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The identifier (arn) of the task template.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    ConstraintsProperties, ConstraintsPropertiesArgs

    InvisibleFields List<Pulumi.AwsNative.Connect.Inputs.TaskTemplateInvisibleFieldInfo>
    Lists the fields that are invisible to agents.
    ReadOnlyFields List<Pulumi.AwsNative.Connect.Inputs.TaskTemplateReadOnlyFieldInfo>
    Lists the fields that are read-only to agents, and cannot be edited.
    RequiredFields List<Pulumi.AwsNative.Connect.Inputs.TaskTemplateRequiredFieldInfo>
    Lists the fields that are required to be filled by agents.
    InvisibleFields []TaskTemplateInvisibleFieldInfo
    Lists the fields that are invisible to agents.
    ReadOnlyFields []TaskTemplateReadOnlyFieldInfo
    Lists the fields that are read-only to agents, and cannot be edited.
    RequiredFields []TaskTemplateRequiredFieldInfo
    Lists the fields that are required to be filled by agents.
    invisibleFields List<TaskTemplateInvisibleFieldInfo>
    Lists the fields that are invisible to agents.
    readOnlyFields List<TaskTemplateReadOnlyFieldInfo>
    Lists the fields that are read-only to agents, and cannot be edited.
    requiredFields List<TaskTemplateRequiredFieldInfo>
    Lists the fields that are required to be filled by agents.
    invisibleFields TaskTemplateInvisibleFieldInfo[]
    Lists the fields that are invisible to agents.
    readOnlyFields TaskTemplateReadOnlyFieldInfo[]
    Lists the fields that are read-only to agents, and cannot be edited.
    requiredFields TaskTemplateRequiredFieldInfo[]
    Lists the fields that are required to be filled by agents.
    invisible_fields Sequence[TaskTemplateInvisibleFieldInfo]
    Lists the fields that are invisible to agents.
    read_only_fields Sequence[TaskTemplateReadOnlyFieldInfo]
    Lists the fields that are read-only to agents, and cannot be edited.
    required_fields Sequence[TaskTemplateRequiredFieldInfo]
    Lists the fields that are required to be filled by agents.
    invisibleFields List<Property Map>
    Lists the fields that are invisible to agents.
    readOnlyFields List<Property Map>
    Lists the fields that are read-only to agents, and cannot be edited.
    requiredFields List<Property Map>
    Lists the fields that are required to be filled by agents.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    TaskTemplateDefaultFieldValue, TaskTemplateDefaultFieldValueArgs

    DefaultValue string
    Default value for the field.
    Id Pulumi.AwsNative.Connect.Inputs.TaskTemplateFieldIdentifier
    Identifier of a field.
    DefaultValue string
    Default value for the field.
    Id TaskTemplateFieldIdentifier
    Identifier of a field.
    defaultValue String
    Default value for the field.
    id TaskTemplateFieldIdentifier
    Identifier of a field.
    defaultValue string
    Default value for the field.
    id TaskTemplateFieldIdentifier
    Identifier of a field.
    default_value str
    Default value for the field.
    id TaskTemplateFieldIdentifier
    Identifier of a field.
    defaultValue String
    Default value for the field.
    id Property Map
    Identifier of a field.

    TaskTemplateField, TaskTemplateFieldArgs

    Id Pulumi.AwsNative.Connect.Inputs.TaskTemplateFieldIdentifier
    The unique identifier for the field.
    Type Pulumi.AwsNative.Connect.TaskTemplateFieldType
    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 string
    The description of the task template's field
    SingleSelectOptions List<string>
    list of field options to be used with single select
    Id TaskTemplateFieldIdentifier
    The unique identifier for the field.
    Type TaskTemplateFieldType
    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 string
    The description of the task template's field
    SingleSelectOptions []string
    list of field options to be used with single select
    id TaskTemplateFieldIdentifier
    The unique identifier for the field.
    type TaskTemplateFieldType
    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 String
    The description of the task template's field
    singleSelectOptions List<String>
    list of field options to be used with single select
    id TaskTemplateFieldIdentifier
    The unique identifier for the field.
    type TaskTemplateFieldType
    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 string
    The description of the task template's field
    singleSelectOptions string[]
    list of field options to be used with single select
    id TaskTemplateFieldIdentifier
    The unique identifier for the field.
    type TaskTemplateFieldType
    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 str
    The description of the task template's field
    single_select_options Sequence[str]
    list of field options to be used with single select
    id Property Map
    The unique identifier for the field.
    type "NAME" | "DESCRIPTION" | "SCHEDULED_TIME" | "QUICK_CONNECT" | "URL" | "NUMBER" | "TEXT" | "TEXT_AREA" | "DATE_TIME" | "BOOLEAN" | "SINGLE_SELECT" | "EMAIL"
    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 String
    The description of the task template's field
    singleSelectOptions List<String>
    list of field options to be used with single select

    TaskTemplateFieldIdentifier, TaskTemplateFieldIdentifierArgs

    Name string
    The name of the task template field
    Name string
    The name of the task template field
    name String
    The name of the task template field
    name string
    The name of the task template field
    name str
    The name of the task template field
    name String
    The name of the task template field

    TaskTemplateFieldType, TaskTemplateFieldTypeArgs

    Name
    NAME
    Description
    DESCRIPTION
    ScheduledTime
    SCHEDULED_TIME
    QuickConnect
    QUICK_CONNECT
    Url
    URL
    Number
    NUMBER
    Text
    TEXT
    TextArea
    TEXT_AREA
    DateTime
    DATE_TIME
    Boolean
    BOOLEAN
    SingleSelect
    SINGLE_SELECT
    Email
    EMAIL
    TaskTemplateFieldTypeName
    NAME
    TaskTemplateFieldTypeDescription
    DESCRIPTION
    TaskTemplateFieldTypeScheduledTime
    SCHEDULED_TIME
    TaskTemplateFieldTypeQuickConnect
    QUICK_CONNECT
    TaskTemplateFieldTypeUrl
    URL
    TaskTemplateFieldTypeNumber
    NUMBER
    TaskTemplateFieldTypeText
    TEXT
    TaskTemplateFieldTypeTextArea
    TEXT_AREA
    TaskTemplateFieldTypeDateTime
    DATE_TIME
    TaskTemplateFieldTypeBoolean
    BOOLEAN
    TaskTemplateFieldTypeSingleSelect
    SINGLE_SELECT
    TaskTemplateFieldTypeEmail
    EMAIL
    Name
    NAME
    Description
    DESCRIPTION
    ScheduledTime
    SCHEDULED_TIME
    QuickConnect
    QUICK_CONNECT
    Url
    URL
    Number
    NUMBER
    Text
    TEXT
    TextArea
    TEXT_AREA
    DateTime
    DATE_TIME
    Boolean
    BOOLEAN
    SingleSelect
    SINGLE_SELECT
    Email
    EMAIL
    Name
    NAME
    Description
    DESCRIPTION
    ScheduledTime
    SCHEDULED_TIME
    QuickConnect
    QUICK_CONNECT
    Url
    URL
    Number
    NUMBER
    Text
    TEXT
    TextArea
    TEXT_AREA
    DateTime
    DATE_TIME
    Boolean
    BOOLEAN
    SingleSelect
    SINGLE_SELECT
    Email
    EMAIL
    NAME
    NAME
    DESCRIPTION
    DESCRIPTION
    SCHEDULED_TIME
    SCHEDULED_TIME
    QUICK_CONNECT
    QUICK_CONNECT
    URL
    URL
    NUMBER
    NUMBER
    TEXT
    TEXT
    TEXT_AREA
    TEXT_AREA
    DATE_TIME
    DATE_TIME
    BOOLEAN
    BOOLEAN
    SINGLE_SELECT
    SINGLE_SELECT
    EMAIL
    EMAIL
    "NAME"
    NAME
    "DESCRIPTION"
    DESCRIPTION
    "SCHEDULED_TIME"
    SCHEDULED_TIME
    "QUICK_CONNECT"
    QUICK_CONNECT
    "URL"
    URL
    "NUMBER"
    NUMBER
    "TEXT"
    TEXT
    "TEXT_AREA"
    TEXT_AREA
    "DATE_TIME"
    DATE_TIME
    "BOOLEAN"
    BOOLEAN
    "SINGLE_SELECT"
    SINGLE_SELECT
    "EMAIL"
    EMAIL

    TaskTemplateInvisibleFieldInfo, TaskTemplateInvisibleFieldInfoArgs

    TaskTemplateReadOnlyFieldInfo, TaskTemplateReadOnlyFieldInfoArgs

    TaskTemplateRequiredFieldInfo, TaskTemplateRequiredFieldInfoArgs

    TaskTemplateStatus, TaskTemplateStatusArgs

    Active
    ACTIVE
    Inactive
    INACTIVE
    TaskTemplateStatusActive
    ACTIVE
    TaskTemplateStatusInactive
    INACTIVE
    Active
    ACTIVE
    Inactive
    INACTIVE
    Active
    ACTIVE
    Inactive
    INACTIVE
    ACTIVE
    ACTIVE
    INACTIVE
    INACTIVE
    "ACTIVE"
    ACTIVE
    "INACTIVE"
    INACTIVE

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native