CfnEvaluationFormProps

class aws_cdk.aws_connect.CfnEvaluationFormProps(*, instance_arn, items, status, title, description=None, scoring_strategy=None, tags=None)

Bases: object

Properties for defining a CfnEvaluationForm.

Parameters:
  • instance_arn (str) – The identifier of the Amazon Connect instance.

  • items (Union[IResolvable, Sequence[Union[IResolvable, EvaluationFormBaseItemProperty, Dict[str, Any]]]]) – 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

  • status (str) – The status of the evaluation form. Allowed values : DRAFT | ACTIVE Default: - “DRAFT”

  • title (str) – A title of the evaluation form.

  • description (Optional[str]) – The description of the evaluation form. Length Constraints : Minimum length of 0. Maximum length of 1024.

  • scoring_strategy (Union[IResolvable, ScoringStrategyProperty, Dict[str, Any], None]) – A scoring strategy of the evaluation form.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:”value1”, “key2”:”value2”} }.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-evaluationform.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_connect as connect

# evaluation_form_section_property_: connect.CfnEvaluationForm.EvaluationFormSectionProperty

cfn_evaluation_form_props = connect.CfnEvaluationFormProps(
    instance_arn="instanceArn",
    items=[connect.CfnEvaluationForm.EvaluationFormBaseItemProperty(
        section=connect.CfnEvaluationForm.EvaluationFormSectionProperty(
            ref_id="refId",
            title="title",

            # the properties below are optional
            instructions="instructions",
            items=[connect.CfnEvaluationForm.EvaluationFormItemProperty(
                question=connect.CfnEvaluationForm.EvaluationFormQuestionProperty(
                    question_type="questionType",
                    ref_id="refId",
                    title="title",

                    # the properties below are optional
                    instructions="instructions",
                    not_applicable_enabled=False,
                    question_type_properties=connect.CfnEvaluationForm.EvaluationFormQuestionTypePropertiesProperty(
                        numeric=connect.CfnEvaluationForm.EvaluationFormNumericQuestionPropertiesProperty(
                            max_value=123,
                            min_value=123,

                            # the properties below are optional
                            automation=connect.CfnEvaluationForm.EvaluationFormNumericQuestionAutomationProperty(
                                property_value=connect.CfnEvaluationForm.NumericQuestionPropertyValueAutomationProperty(
                                    label="label"
                                )
                            ),
                            options=[connect.CfnEvaluationForm.EvaluationFormNumericQuestionOptionProperty(
                                max_value=123,
                                min_value=123,

                                # the properties below are optional
                                automatic_fail=False,
                                score=123
                            )]
                        ),
                        single_select=connect.CfnEvaluationForm.EvaluationFormSingleSelectQuestionPropertiesProperty(
                            options=[connect.CfnEvaluationForm.EvaluationFormSingleSelectQuestionOptionProperty(
                                ref_id="refId",
                                text="text",

                                # the properties below are optional
                                automatic_fail=False,
                                score=123
                            )],

                            # the properties below are optional
                            automation=connect.CfnEvaluationForm.EvaluationFormSingleSelectQuestionAutomationProperty(
                                options=[connect.CfnEvaluationForm.EvaluationFormSingleSelectQuestionAutomationOptionProperty(
                                    rule_category=connect.CfnEvaluationForm.SingleSelectQuestionRuleCategoryAutomationProperty(
                                        category="category",
                                        condition="condition",
                                        option_ref_id="optionRefId"
                                    )
                                )],

                                # the properties below are optional
                                default_option_ref_id="defaultOptionRefId"
                            ),
                            display_as="displayAs"
                        )
                    ),
                    weight=123
                ),
                section=evaluation_form_section_property_
            )],
            weight=123
        )
    )],
    status="status",
    title="title",

    # the properties below are optional
    description="description",
    scoring_strategy=connect.CfnEvaluationForm.ScoringStrategyProperty(
        mode="mode",
        status="status"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

The description of the evaluation form.

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-evaluationform.html#cfn-connect-evaluationform-description

instance_arn

The identifier of the Amazon Connect instance.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-evaluationform.html#cfn-connect-evaluationform-instancearn

items

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-evaluationform.html#cfn-connect-evaluationform-items

scoring_strategy

A scoring strategy of the evaluation form.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-evaluationform.html#cfn-connect-evaluationform-scoringstrategy

status

The status of the evaluation form.

Allowed values : DRAFT | ACTIVE

Default:
  • “DRAFT”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-evaluationform.html#cfn-connect-evaluationform-status

tags

The tags used to organize, track, or control access for this resource.

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-evaluationform.html#cfn-connect-evaluationform-tags

title

A title of the evaluation form.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-evaluationform.html#cfn-connect-evaluationform-title