We recommend new projects start with resources from the AWS provider.
aws-native.connect.TaskTemplate
We recommend new projects start with resources from the AWS provider.
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,
                 self_assign_contact_flow_arn: 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.Aws Native. Connect. Inputs. Constraints Properties 
- The constraints for the task template
- ContactFlow stringArn 
- The identifier of the contact flow.
- Defaults
List<Pulumi.Aws Native. Connect. Inputs. Task Template Default Field Value> 
- 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.Aws Native. Connect. Inputs. Task Template Field> 
- The list of task template's fields
- Name string
- The name of the task template.
- SelfAssign stringContact Flow Arn 
- The identifier of the contact flow.
- Status
Pulumi.Aws Native. Connect. Task Template Status 
- The status of the task template.
- 
List<Pulumi.Aws Native. 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
ConstraintsProperties Args 
- The constraints for the task template
- ContactFlow stringArn 
- The identifier of the contact flow.
- Defaults
[]TaskTemplate Default Field Value Args 
- The default values for fields when a task is created by referencing this template.
- Description string
- The description of the task template.
- Fields
[]TaskTemplate Field Args 
- The list of task template's fields
- Name string
- The name of the task template.
- SelfAssign stringContact Flow Arn 
- The identifier of the contact flow.
- Status
TaskTemplate Status 
- The status of the task template.
- 
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
- contactFlow StringArn 
- The identifier of the contact flow.
- defaults
List<TaskTemplate Default Field Value> 
- The default values for fields when a task is created by referencing this template.
- description String
- The description of the task template.
- fields
List<TaskTemplate Field> 
- The list of task template's fields
- name String
- The name of the task template.
- selfAssign StringContact Flow Arn 
- The identifier of the contact flow.
- status
TaskTemplate Status 
- The status of the task template.
- 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
- contactFlow stringArn 
- The identifier of the contact flow.
- defaults
TaskTemplate Default Field Value[] 
- The default values for fields when a task is created by referencing this template.
- description string
- The description of the task template.
- fields
TaskTemplate Field[] 
- The list of task template's fields
- name string
- The name of the task template.
- selfAssign stringContact Flow Arn 
- The identifier of the contact flow.
- status
TaskTemplate Status 
- The status of the task template.
- 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
ConstraintsProperties Args 
- The constraints for the task template
- contact_flow_ strarn 
- The identifier of the contact flow.
- defaults
Sequence[TaskTemplate Default Field Value Args] 
- The default values for fields when a task is created by referencing this template.
- description str
- The description of the task template.
- fields
Sequence[TaskTemplate Field Args] 
- The list of task template's fields
- name str
- The name of the task template.
- self_assign_ strcontact_ flow_ arn 
- The identifier of the contact flow.
- status
TaskTemplate Status 
- The status of the task template.
- 
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
- contactFlow StringArn 
- 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.
- selfAssign StringContact Flow Arn 
- The identifier of the contact flow.
- status "ACTIVE" | "INACTIVE"
- The status of the task template.
- 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:
Supporting Types
ConstraintsProperties, ConstraintsPropertiesArgs    
The constraints for the task template- InvisibleFields List<Pulumi.Aws Native. Connect. Inputs. Task Template Invisible Field Info> 
- Lists the fields that are invisible to agents.
- ReadOnly List<Pulumi.Fields Aws Native. Connect. Inputs. Task Template Read Only Field Info> 
- Lists the fields that are read-only to agents, and cannot be edited.
- RequiredFields List<Pulumi.Aws Native. Connect. Inputs. Task Template Required Field Info> 
- Lists the fields that are required to be filled by agents.
- InvisibleFields []TaskTemplate Invisible Field Info 
- Lists the fields that are invisible to agents.
- ReadOnly []TaskFields Template Read Only Field Info 
- Lists the fields that are read-only to agents, and cannot be edited.
- RequiredFields []TaskTemplate Required Field Info 
- Lists the fields that are required to be filled by agents.
- invisibleFields List<TaskTemplate Invisible Field Info> 
- Lists the fields that are invisible to agents.
- readOnly List<TaskFields Template Read Only Field Info> 
- Lists the fields that are read-only to agents, and cannot be edited.
- requiredFields List<TaskTemplate Required Field Info> 
- Lists the fields that are required to be filled by agents.
- invisibleFields TaskTemplate Invisible Field Info[] 
- Lists the fields that are invisible to agents.
- readOnly TaskFields Template Read Only Field Info[] 
- Lists the fields that are read-only to agents, and cannot be edited.
- requiredFields TaskTemplate Required Field Info[] 
- Lists the fields that are required to be filled by agents.
- invisible_fields Sequence[TaskTemplate Invisible Field Info] 
- Lists the fields that are invisible to agents.
- read_only_ Sequence[Taskfields Template Read Only Field Info] 
- Lists the fields that are read-only to agents, and cannot be edited.
- required_fields Sequence[TaskTemplate Required Field Info] 
- Lists the fields that are required to be filled by agents.
- invisibleFields List<Property Map>
- Lists the fields that are invisible to agents.
- readOnly List<Property Map>Fields 
- 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  
A set of tags to apply to the resource.TaskTemplateDefaultFieldValue, TaskTemplateDefaultFieldValueArgs          
the default value for the task template's field- DefaultValue string
- Default value for the field.
- Id
Pulumi.Aws Native. Connect. Inputs. Task Template Field Identifier 
- Identifier of a field.
- DefaultValue string
- Default value for the field.
- Id
TaskTemplate Field Identifier 
- Identifier of a field.
- defaultValue String
- Default value for the field.
- id
TaskTemplate Field Identifier 
- Identifier of a field.
- defaultValue string
- Default value for the field.
- id
TaskTemplate Field Identifier 
- Identifier of a field.
- default_value str
- Default value for the field.
- id
TaskTemplate Field Identifier 
- Identifier of a field.
- defaultValue String
- Default value for the field.
- id Property Map
- Identifier of a field.
TaskTemplateField, TaskTemplateFieldArgs      
A task template field object.- Id
Pulumi.Aws Native. Connect. Inputs. Task Template Field Identifier 
- The unique identifier for the field.
- Type
Pulumi.Aws Native. Connect. Task Template Field Type 
- Indicates the type of field. Following are the valid field types: NAMEDESCRIPTION|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
- SingleSelect List<string>Options 
- list of field options to be used with single select
- Id
TaskTemplate Field Identifier 
- The unique identifier for the field.
- Type
TaskTemplate Field Type 
- Indicates the type of field. Following are the valid field types: NAMEDESCRIPTION|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
- SingleSelect []stringOptions 
- list of field options to be used with single select
- id
TaskTemplate Field Identifier 
- The unique identifier for the field.
- type
TaskTemplate Field Type 
- Indicates the type of field. Following are the valid field types: NAMEDESCRIPTION|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
- singleSelect List<String>Options 
- list of field options to be used with single select
- id
TaskTemplate Field Identifier 
- The unique identifier for the field.
- type
TaskTemplate Field Type 
- Indicates the type of field. Following are the valid field types: NAMEDESCRIPTION|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
- singleSelect string[]Options 
- list of field options to be used with single select
- id
TaskTemplate Field Identifier 
- The unique identifier for the field.
- type
TaskTemplate Field Type 
- Indicates the type of field. Following are the valid field types: NAMEDESCRIPTION|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_ Sequence[str]options 
- 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" | "EXPIRY_DURATION" | "SELF_ASSIGN"
- Indicates the type of field. Following are the valid field types: NAMEDESCRIPTION|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
- singleSelect List<String>Options 
- list of field options to be used with single select
TaskTemplateFieldIdentifier, TaskTemplateFieldIdentifierArgs        
the identifier (name) for 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 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
- ExpiryDuration 
- EXPIRY_DURATION
- SelfAssign 
- SELF_ASSIGN
- TaskTemplate Field Type Name 
- NAME
- TaskTemplate Field Type Description 
- DESCRIPTION
- TaskTemplate Field Type Scheduled Time 
- SCHEDULED_TIME
- TaskTemplate Field Type Quick Connect 
- QUICK_CONNECT
- TaskTemplate Field Type Url 
- URL
- TaskTemplate Field Type Number 
- NUMBER
- TaskTemplate Field Type Text 
- TEXT
- TaskTemplate Field Type Text Area 
- TEXT_AREA
- TaskTemplate Field Type Date Time 
- DATE_TIME
- TaskTemplate Field Type Boolean 
- BOOLEAN
- TaskTemplate Field Type Single Select 
- SINGLE_SELECT
- TaskTemplate Field Type Email 
- TaskTemplate Field Type Expiry Duration 
- EXPIRY_DURATION
- TaskTemplate Field Type Self Assign 
- SELF_ASSIGN
- 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
- ExpiryDuration 
- EXPIRY_DURATION
- SelfAssign 
- SELF_ASSIGN
- 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
- ExpiryDuration 
- EXPIRY_DURATION
- SelfAssign 
- SELF_ASSIGN
- 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
- EXPIRY_DURATION
- EXPIRY_DURATION
- SELF_ASSIGN
- SELF_ASSIGN
- "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"
- "EXPIRY_DURATION"
- EXPIRY_DURATION
- "SELF_ASSIGN"
- SELF_ASSIGN
TaskTemplateInvisibleFieldInfo, TaskTemplateInvisibleFieldInfoArgs          
Invisible field infoTaskTemplateReadOnlyFieldInfo, TaskTemplateReadOnlyFieldInfoArgs            
ReadOnly field infoTaskTemplateRequiredFieldInfo, TaskTemplateRequiredFieldInfoArgs          
Required field infoTaskTemplateStatus, TaskTemplateStatusArgs      
- Active
- ACTIVE
- Inactive
- INACTIVE
- TaskTemplate Status Active 
- ACTIVE
- TaskTemplate Status Inactive 
- 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
We recommend new projects start with resources from the AWS provider.
