Package software.amazon.awscdk.services.connect

Interface CfnTaskTemplateProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnTaskTemplateProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.021Z") @Stability(Stable) public interface CfnTaskTemplateProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnTaskTemplate.

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;
 CfnTaskTemplateProps cfnTaskTemplateProps = CfnTaskTemplateProps.builder()
         .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")
         .status("status")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Method Details

    • getInstanceArn

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

    • getClientToken

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

    • getConstraints

      @Stability(Stable) @Nullable default Object getConstraints()
      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.

    • getContactFlowArn

      @Stability(Stable) @Nullable default String getContactFlowArn()
      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 .

    • getDefaults

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

    • getDescription

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

    • getFields

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

      A template requires at least one field that has type Name .

    • getName

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

    • getStatus

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

    • getTags

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

    • builder

      @Stability(Stable) static CfnTaskTemplateProps.Builder builder()
      Returns:
      a CfnTaskTemplateProps.Builder of CfnTaskTemplateProps