Interface CfnEvaluationFormProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnEvaluationFormProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:55.969Z") @Stability(Stable) public interface CfnEvaluationFormProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnEvaluationForm.

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.*;
 EvaluationFormSectionProperty evaluationFormSectionProperty_;
 CfnEvaluationFormProps cfnEvaluationFormProps = CfnEvaluationFormProps.builder()
         .instanceArn("instanceArn")
         .items(List.of(EvaluationFormBaseItemProperty.builder()
                 .section(EvaluationFormSectionProperty.builder()
                         .refId("refId")
                         .title("title")
                         // the properties below are optional
                         .instructions("instructions")
                         .items(List.of(EvaluationFormItemProperty.builder()
                                 .question(EvaluationFormQuestionProperty.builder()
                                         .questionType("questionType")
                                         .refId("refId")
                                         .title("title")
                                         // the properties below are optional
                                         .instructions("instructions")
                                         .notApplicableEnabled(false)
                                         .questionTypeProperties(EvaluationFormQuestionTypePropertiesProperty.builder()
                                                 .numeric(EvaluationFormNumericQuestionPropertiesProperty.builder()
                                                         .maxValue(123)
                                                         .minValue(123)
                                                         // the properties below are optional
                                                         .automation(EvaluationFormNumericQuestionAutomationProperty.builder()
                                                                 .propertyValue(NumericQuestionPropertyValueAutomationProperty.builder()
                                                                         .label("label")
                                                                         .build())
                                                                 .build())
                                                         .options(List.of(EvaluationFormNumericQuestionOptionProperty.builder()
                                                                 .maxValue(123)
                                                                 .minValue(123)
                                                                 // the properties below are optional
                                                                 .automaticFail(false)
                                                                 .score(123)
                                                                 .build()))
                                                         .build())
                                                 .singleSelect(EvaluationFormSingleSelectQuestionPropertiesProperty.builder()
                                                         .options(List.of(EvaluationFormSingleSelectQuestionOptionProperty.builder()
                                                                 .refId("refId")
                                                                 .text("text")
                                                                 // the properties below are optional
                                                                 .automaticFail(false)
                                                                 .score(123)
                                                                 .build()))
                                                         // the properties below are optional
                                                         .automation(EvaluationFormSingleSelectQuestionAutomationProperty.builder()
                                                                 .options(List.of(EvaluationFormSingleSelectQuestionAutomationOptionProperty.builder()
                                                                         .ruleCategory(SingleSelectQuestionRuleCategoryAutomationProperty.builder()
                                                                                 .category("category")
                                                                                 .condition("condition")
                                                                                 .optionRefId("optionRefId")
                                                                                 .build())
                                                                         .build()))
                                                                 // the properties below are optional
                                                                 .defaultOptionRefId("defaultOptionRefId")
                                                                 .build())
                                                         .displayAs("displayAs")
                                                         .build())
                                                 .build())
                                         .weight(123)
                                         .build())
                                 .section(evaluationFormSectionProperty_)
                                 .build()))
                         .weight(123)
                         .build())
                 .build()))
         .status("status")
         .title("title")
         // the properties below are optional
         .description("description")
         .scoringStrategy(ScoringStrategyProperty.builder()
                 .mode("mode")
                 .status("status")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 
  • Method Details

    • getInstanceArn

      @Stability(Stable) @NotNull String getInstanceArn()
      The identifier of the Amazon Connect instance.
    • getItems

      @Stability(Stable) @NotNull Object getItems()
      Items that are part of the evaluation form.

      The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.

      Minimum size : 1

      Maximum size : 100

    • getStatus

      @Stability(Stable) @NotNull String getStatus()
      The status of the evaluation form.

      Allowed values : DRAFT | ACTIVE

    • getTitle

      @Stability(Stable) @NotNull String getTitle()
      A title of the evaluation form.
    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      The description of the evaluation form.

      Length Constraints : Minimum length of 0. Maximum length of 1024.

    • getScoringStrategy

      @Stability(Stable) @Nullable default Object getScoringStrategy()
      A scoring strategy of the evaluation form.
    • getTags

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

      For example, { "tags": {"key1":"value1", "key2":"value2"} }.

    • builder

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