Package software.amazon.awscdk.services.connect

Class CfnTaskTemplate

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.connect.CfnTaskTemplate
All Implemented Interfaces:
IInspectable, ITaskTemplateRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:33.670Z") @Stability(Stable) public class CfnTaskTemplate extends CfnResource implements IInspectable, ITaskTemplateRef, ITaggable
Specifies a task template for a Amazon Connect instance.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.connect.*;
 Object constraints;
 CfnTaskTemplate cfnTaskTemplate = CfnTaskTemplate.Builder.create(this, "MyCfnTaskTemplate")
         .instanceArn("instanceArn")
         // the properties below are optional
         .clientToken("clientToken")
         .constraints(constraints)
         .contactFlowArn("contactFlowArn")
         .defaults(List.of(DefaultFieldValueProperty.builder()
                 .defaultValue("defaultValue")
                 .id(FieldIdentifierProperty.builder()
                         .name("name")
                         .build())
                 .build()))
         .description("description")
         .fields(List.of(FieldProperty.builder()
                 .id(FieldIdentifierProperty.builder()
                         .name("name")
                         .build())
                 .type("type")
                 // the properties below are optional
                 .description("description")
                 .singleSelectOptions(List.of("singleSelectOptions"))
                 .build()))
         .name("name")
         .selfAssignContactFlowArn("selfAssignContactFlowArn")
         .status("status")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnTaskTemplate

      protected CfnTaskTemplate(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnTaskTemplate

      protected CfnTaskTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnTaskTemplate

      @Stability(Stable) public CfnTaskTemplate(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnTaskTemplateProps props)
      Create a new AWS::Connect::TaskTemplate.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForTaskTemplate

      @Stability(Stable) @NotNull public static String arnForTaskTemplate(@NotNull ITaskTemplateRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnTaskTemplate

      @Stability(Stable) @NotNull public static Boolean isCfnTaskTemplate(@NotNull Object x)
      Checks whether the given object is a CfnTaskTemplate.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the task template.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getTaskTemplateRef

      @Stability(Stable) @NotNull public TaskTemplateReference getTaskTemplateRef()
      A reference to a TaskTemplate resource.
      Specified by:
      getTaskTemplateRef in interface ITaskTemplateRef

    • getInstanceArn

      @Stability(Stable) @NotNull public String getInstanceArn()
      The Amazon Resource Name (ARN) of the Amazon Connect instance.

    • setInstanceArn

      @Stability(Stable) public void setInstanceArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the Amazon Connect instance.

    • getClientToken

      @Stability(Stable) @Nullable public String getClientToken()
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    • setClientToken

      @Stability(Stable) public void setClientToken(@Nullable String value)
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    • getConstraints

      @Stability(Stable) @Nullable public Object getConstraints()
      Constraints that are applicable to the fields listed.

    • setConstraints

      @Stability(Stable) public void setConstraints(@Nullable Object value)
      Constraints that are applicable to the fields listed.

    • getContactFlowArn

      @Stability(Stable) @Nullable public String getContactFlowArn()
      The Amazon Resource Name (ARN) of the flow that runs by default when a task is created by referencing this template.

    • setContactFlowArn

      @Stability(Stable) public void setContactFlowArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the flow that runs by default when a task is created by referencing this template.

    • getDefaults

      @Stability(Stable) @Nullable public Object getDefaults()
      The default values for fields when a task is created by referencing this template.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTaskTemplate.DefaultFieldValueProperty>

    • setDefaults

      @Stability(Stable) public void setDefaults(@Nullable IResolvable value)
      The default values for fields when a task is created by referencing this template.

    • setDefaults

      @Stability(Stable) public void setDefaults(@Nullable List<Object> value)
      The default values for fields when a task is created by referencing this template.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the task template.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the task template.

    • getFields

      @Stability(Stable) @Nullable public Object getFields()
      Fields that are part of the template.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTaskTemplate.FieldProperty>

    • setFields

      @Stability(Stable) public void setFields(@Nullable IResolvable value)
      Fields that are part of the template.

    • setFields

      @Stability(Stable) public void setFields(@Nullable List<Object> value)
      Fields that are part of the template.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the task template.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the task template.

    • getSelfAssignContactFlowArn

      @Stability(Stable) @Nullable public String getSelfAssignContactFlowArn()
      The Amazon Resource Name (ARN) of the flow.

    • setSelfAssignContactFlowArn

      @Stability(Stable) public void setSelfAssignContactFlowArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the flow.

    • getStatus

      @Stability(Stable) @Nullable public String getStatus()
      The status of the task template.

    • setStatus

      @Stability(Stable) public void setStatus(@Nullable String value)
      The status of the task template.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags used to organize, track, or control access for this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags used to organize, track, or control access for this resource.