CfnEvaluationForm

class aws_cdk.aws_connect.CfnEvaluationForm(scope, id, *, instance_arn, items, status, title, description=None, scoring_strategy=None, tags=None)

Bases: CfnResource

A CloudFormation AWS::Connect::EvaluationForm.

Creates an evaluation form for the specified Amazon Connect instance.

CloudformationResource:: AWS::Connect::EvaluationForm
Link:: 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.
import aws_cdk.aws_connect as connect

# evaluation_form_section_property_: connect.CfnEvaluationForm.EvaluationFormSectionProperty

cfn_evaluation_form = connect.CfnEvaluationForm(self, "MyCfnEvaluationForm",
    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"
    )]
)

Create a new AWS::Connect::EvaluationForm.

Parameters:

scope (Construct) –
- scope in which this resource is defined.
id (str) –
- scoped id of the resource.
instance_arn (str) – The identifier of the Amazon Connect instance.
items (Union[IResolvable, Sequence[Union[EvaluationFormBaseItemProperty, Dict[str, Any], IResolvable]]]) – 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
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”} }.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type:

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:: attribute_name (str) – The name of the attribute.
Return type:: Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) –

tree inspector to collect and process attributes.

Return type:

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Connect::EvaluationForm'

attr_evaluation_form_arn

The Amazon Resource Name (ARN) of the evaluation form.

CloudformationAttribute:: EvaluationFormArn

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description

The description of the evaluation form.

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

Link:: 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.

Link:: 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

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

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node: The construct tree node associated with this construct.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

scoring_strategy

A scoring strategy of the evaluation form.

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

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

status

The status of the evaluation form.

Allowed values : DRAFT | ACTIVE

Link:: 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”} }.

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

title

A title of the evaluation form.

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

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

EvaluationFormBaseItemProperty

class CfnEvaluationForm.EvaluationFormBaseItemProperty(*, section)

Bases: object

An item at the root level.

All items must be sections.

Parameters:: section (Union[IResolvable, EvaluationFormSectionProperty, Dict[str, Any]]) – A subsection or inner section of an item.
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformbaseitem.html
ExampleMetadata:: fixture=_generated

Example:

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

# evaluation_form_section_property_: connect.CfnEvaluationForm.EvaluationFormSectionProperty

evaluation_form_base_item_property = 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
    )
)

Attributes

section

A subsection or inner section of an item.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformbaseitem.html#cfn-connect-evaluationform-evaluationformbaseitem-section

EvaluationFormItemProperty

class CfnEvaluationForm.EvaluationFormItemProperty(*, question=None, section=None)

Bases: object

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.

Parameters:

question (Union[IResolvable, EvaluationFormQuestionProperty, Dict[str, Any], None]) – The information of the question.
section (Union[IResolvable, EvaluationFormSectionProperty, Dict[str, Any], None]) – The information of the section.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

# evaluation_form_section_property_: connect.CfnEvaluationForm.EvaluationFormSectionProperty

evaluation_form_item_property = 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=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
    )
)

Attributes

question

The information of the question.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformitem.html#cfn-connect-evaluationform-evaluationformitem-question

section

The information of the section.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformitem.html#cfn-connect-evaluationform-evaluationformitem-section

EvaluationFormNumericQuestionAutomationProperty

class CfnEvaluationForm.EvaluationFormNumericQuestionAutomationProperty(*, property_value)

Bases: object

Information about the automation configuration in numeric questions.

Parameters:: property_value (Union[IResolvable, NumericQuestionPropertyValueAutomationProperty, Dict[str, Any]]) – The property value of the automation.
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformnumericquestionautomation.html
ExampleMetadata:: fixture=_generated

Example:

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

evaluation_form_numeric_question_automation_property = connect.CfnEvaluationForm.EvaluationFormNumericQuestionAutomationProperty(
    property_value=connect.CfnEvaluationForm.NumericQuestionPropertyValueAutomationProperty(
        label="label"
    )
)

Attributes

property_value

The property value of the automation.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformnumericquestionautomation.html#cfn-connect-evaluationform-evaluationformnumericquestionautomation-propertyvalue

EvaluationFormNumericQuestionOptionProperty

class CfnEvaluationForm.EvaluationFormNumericQuestionOptionProperty(*, max_value, min_value, automatic_fail=None, score=None)

Bases: object

Information about the option range used for scoring in numeric questions.

Parameters:

max_value (Union[int, float]) – The maximum answer value of the range option.
min_value (Union[int, float]) – The minimum answer value of the range option.
automatic_fail (Union[bool, IResolvable, None]) – The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
score (Union[int, float, None]) – The score assigned to answer values within the range option. Minimum : 0 Maximum : 10

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

evaluation_form_numeric_question_option_property = connect.CfnEvaluationForm.EvaluationFormNumericQuestionOptionProperty(
    max_value=123,
    min_value=123,

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

Attributes

automatic_fail

The flag to mark the option as automatic fail.

If an automatic fail answer is provided, the overall evaluation gets a score of 0.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformnumericquestionoption.html#cfn-connect-evaluationform-evaluationformnumericquestionoption-automaticfail

max_value

The maximum answer value of the range option.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformnumericquestionoption.html#cfn-connect-evaluationform-evaluationformnumericquestionoption-maxvalue

min_value

The minimum answer value of the range option.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformnumericquestionoption.html#cfn-connect-evaluationform-evaluationformnumericquestionoption-minvalue

score

The score assigned to answer values within the range option.

Minimum : 0

Maximum : 10

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformnumericquestionoption.html#cfn-connect-evaluationform-evaluationformnumericquestionoption-score

EvaluationFormNumericQuestionPropertiesProperty

class CfnEvaluationForm.EvaluationFormNumericQuestionPropertiesProperty(*, max_value, min_value, automation=None, options=None)

Bases: object

Information about properties for a numeric question in an evaluation form.

Parameters:

max_value (Union[int, float]) – The maximum answer value.
min_value (Union[int, float]) – The minimum answer value.
automation (Union[IResolvable, EvaluationFormNumericQuestionAutomationProperty, Dict[str, Any], None]) – The automation properties of the numeric question.
options (Union[IResolvable, Sequence[Union[IResolvable, EvaluationFormNumericQuestionOptionProperty, Dict[str, Any]]], None]) – The scoring options of the numeric question.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

evaluation_form_numeric_question_properties_property = 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
    )]
)

Attributes

automation

The automation properties of the numeric question.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformnumericquestionproperties.html#cfn-connect-evaluationform-evaluationformnumericquestionproperties-automation

max_value

The maximum answer value.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformnumericquestionproperties.html#cfn-connect-evaluationform-evaluationformnumericquestionproperties-maxvalue

min_value

The minimum answer value.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformnumericquestionproperties.html#cfn-connect-evaluationform-evaluationformnumericquestionproperties-minvalue

options

The scoring options of the numeric question.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformnumericquestionproperties.html#cfn-connect-evaluationform-evaluationformnumericquestionproperties-options

EvaluationFormQuestionProperty

class CfnEvaluationForm.EvaluationFormQuestionProperty(*, question_type, ref_id, title, instructions=None, not_applicable_enabled=None, question_type_properties=None, weight=None)

Bases: object

Information about a question from an evaluation form.

Parameters:

question_type (str) – The type of the question. Allowed values : NUMERIC | SINGLESELECT | TEXT
ref_id (str) – The identifier of the question. An identifier must be unique within the evaluation form. Length Constraints : Minimum length of 1. Maximum length of 40.
title (str) – The title of the question. Length Constraints : Minimum length of 1. Maximum length of 350.
instructions (Optional[str]) – The instructions of the section. Length Constraints : Minimum length of 0. Maximum length of 1024.
not_applicable_enabled (Union[bool, IResolvable, None]) – The flag to enable not applicable answers to the question.
question_type_properties (Union[IResolvable, EvaluationFormQuestionTypePropertiesProperty, Dict[str, Any], None]) – The properties of the type of question. Text questions do not have to define question type properties.
weight (Union[int, float, None]) – The scoring weight of the section. Minimum : 0 Maximum : 100

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

evaluation_form_question_property = 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
)

Attributes

instructions

The instructions of the section.

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

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformquestion.html#cfn-connect-evaluationform-evaluationformquestion-instructions

not_applicable_enabled

The flag to enable not applicable answers to the question.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformquestion.html#cfn-connect-evaluationform-evaluationformquestion-notapplicableenabled

question_type

The type of the question.

Allowed values : NUMERIC | SINGLESELECT | TEXT

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformquestion.html#cfn-connect-evaluationform-evaluationformquestion-questiontype

question_type_properties

The properties of the type of question.

Text questions do not have to define question type properties.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformquestion.html#cfn-connect-evaluationform-evaluationformquestion-questiontypeproperties

ref_id

The identifier of the question. An identifier must be unique within the evaluation form.

Length Constraints : Minimum length of 1. Maximum length of 40.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformquestion.html#cfn-connect-evaluationform-evaluationformquestion-refid

title

The title of the question.

Length Constraints : Minimum length of 1. Maximum length of 350.

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

weight

The scoring weight of the section.

Minimum : 0

Maximum : 100

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformquestion.html#cfn-connect-evaluationform-evaluationformquestion-weight

EvaluationFormQuestionTypePropertiesProperty

class CfnEvaluationForm.EvaluationFormQuestionTypePropertiesProperty(*, numeric=None, single_select=None)

Bases: object

Information about properties for a question in an evaluation form.

The question type properties must be either for a numeric question or a single select question.

Parameters:

numeric (Union[IResolvable, EvaluationFormNumericQuestionPropertiesProperty, Dict[str, Any], None]) – The properties of the numeric question.
single_select (Union[IResolvable, EvaluationFormSingleSelectQuestionPropertiesProperty, Dict[str, Any], None]) – The properties of the numeric question.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

evaluation_form_question_type_properties_property = 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"
    )
)

Attributes

numeric

The properties of the numeric question.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformquestiontypeproperties.html#cfn-connect-evaluationform-evaluationformquestiontypeproperties-numeric

single_select

The properties of the numeric question.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformquestiontypeproperties.html#cfn-connect-evaluationform-evaluationformquestiontypeproperties-singleselect

EvaluationFormSectionProperty

class CfnEvaluationForm.EvaluationFormSectionProperty(*, ref_id, title, instructions=None, items=None, weight=None)

Bases: object

Information about a section from an evaluation form.

A section can contain sections and/or questions. Evaluation forms can only contain sections and subsections (two level nesting).

Parameters:

ref_id (str) – The identifier of the section. An identifier must be unique within the evaluation form. Length Constraints : Minimum length of 1. Maximum length of 40.
title (str) – The title of the section. Length Constraints : Minimum length of 1. Maximum length of 128.
instructions (Optional[str]) – The instructions of the section.
items (Union[IResolvable, Sequence[Union[IResolvable, EvaluationFormItemProperty, Dict[str, Any]]], None]) – The items of the section. Minimum : 1
weight (Union[int, float, None]) – The scoring weight of the section. Minimum : 0 Maximum : 100

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

# evaluation_form_item_property_: connect.CfnEvaluationForm.EvaluationFormItemProperty

evaluation_form_section_property = 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=connect.CfnEvaluationForm.EvaluationFormSectionProperty(
            ref_id="refId",
            title="title",

            # the properties below are optional
            instructions="instructions",
            items=[evaluation_form_item_property_],
            weight=123
        )
    )],
    weight=123
)

Attributes

instructions

The instructions of the section.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsection.html#cfn-connect-evaluationform-evaluationformsection-instructions

items

The items of the section.

Minimum : 1

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

ref_id

The identifier of the section. An identifier must be unique within the evaluation form.

Length Constraints : Minimum length of 1. Maximum length of 40.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsection.html#cfn-connect-evaluationform-evaluationformsection-refid

title

The title of the section.

Length Constraints : Minimum length of 1. Maximum length of 128.

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

weight

The scoring weight of the section.

Minimum : 0

Maximum : 100

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsection.html#cfn-connect-evaluationform-evaluationformsection-weight

EvaluationFormSingleSelectQuestionAutomationOptionProperty

class CfnEvaluationForm.EvaluationFormSingleSelectQuestionAutomationOptionProperty(*, rule_category)

Bases: object

The automation options of the single select question.

Parameters:: rule_category (Union[IResolvable, SingleSelectQuestionRuleCategoryAutomationProperty, Dict[str, Any]]) – The automation option based on a rule category for the single select question.
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionautomationoption.html
ExampleMetadata:: fixture=_generated

Example:

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

evaluation_form_single_select_question_automation_option_property = connect.CfnEvaluationForm.EvaluationFormSingleSelectQuestionAutomationOptionProperty(
    rule_category=connect.CfnEvaluationForm.SingleSelectQuestionRuleCategoryAutomationProperty(
        category="category",
        condition="condition",
        option_ref_id="optionRefId"
    )
)

Attributes

rule_category

The automation option based on a rule category for the single select question.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionautomationoption.html#cfn-connect-evaluationform-evaluationformsingleselectquestionautomationoption-rulecategory

EvaluationFormSingleSelectQuestionAutomationProperty

class CfnEvaluationForm.EvaluationFormSingleSelectQuestionAutomationProperty(*, options, default_option_ref_id=None)

Bases: object

Information about the automation configuration in single select questions.

Automation options are evaluated in order, and the first matched option is applied. If no automation option matches, and there is a default option, then the default option is applied.

Parameters:

options (Union[IResolvable, Sequence[Union[IResolvable, EvaluationFormSingleSelectQuestionAutomationOptionProperty, Dict[str, Any]]]]) – The automation options of the single select question. Minimum : 1 Maximum : 20
default_option_ref_id (Optional[str]) – The identifier of the default answer option, when none of the automation options match the criteria. Length Constraints : Minimum length of 1. Maximum length of 40.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

evaluation_form_single_select_question_automation_property = 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"
)

Attributes

default_option_ref_id

The identifier of the default answer option, when none of the automation options match the criteria.

Length Constraints : Minimum length of 1. Maximum length of 40.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionautomation.html#cfn-connect-evaluationform-evaluationformsingleselectquestionautomation-defaultoptionrefid

options

The automation options of the single select question.

Minimum : 1

Maximum : 20

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionautomation.html#cfn-connect-evaluationform-evaluationformsingleselectquestionautomation-options

EvaluationFormSingleSelectQuestionOptionProperty

class CfnEvaluationForm.EvaluationFormSingleSelectQuestionOptionProperty(*, ref_id, text, automatic_fail=None, score=None)

Bases: object

Information about the automation configuration in single select questions.

Parameters:

ref_id (str) – The identifier of the answer option. An identifier must be unique within the question. Length Constraints : Minimum length of 1. Maximum length of 40.
text (str) – The title of the answer option. Length Constraints : Minimum length of 1. Maximum length of 128.
automatic_fail (Union[bool, IResolvable, None]) – The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
score (Union[int, float, None]) – The score assigned to the answer option. Minimum : 0 Maximum : 10

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

evaluation_form_single_select_question_option_property = connect.CfnEvaluationForm.EvaluationFormSingleSelectQuestionOptionProperty(
    ref_id="refId",
    text="text",

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

Attributes

automatic_fail

The flag to mark the option as automatic fail.

If an automatic fail answer is provided, the overall evaluation gets a score of 0.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionoption.html#cfn-connect-evaluationform-evaluationformsingleselectquestionoption-automaticfail

ref_id

The identifier of the answer option. An identifier must be unique within the question.

Length Constraints : Minimum length of 1. Maximum length of 40.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionoption.html#cfn-connect-evaluationform-evaluationformsingleselectquestionoption-refid

score

The score assigned to the answer option.

Minimum : 0

Maximum : 10

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionoption.html#cfn-connect-evaluationform-evaluationformsingleselectquestionoption-score

text

The title of the answer option.

Length Constraints : Minimum length of 1. Maximum length of 128.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionoption.html#cfn-connect-evaluationform-evaluationformsingleselectquestionoption-text

EvaluationFormSingleSelectQuestionPropertiesProperty

class CfnEvaluationForm.EvaluationFormSingleSelectQuestionPropertiesProperty(*, options, automation=None, display_as=None)

Bases: object

Information about the options in single select questions.

Parameters:

options (Union[IResolvable, Sequence[Union[IResolvable, EvaluationFormSingleSelectQuestionOptionProperty, Dict[str, Any]]]]) – The answer options of the single select question. Minimum : 2 Maximum : 256
automation (Union[IResolvable, EvaluationFormSingleSelectQuestionAutomationProperty, Dict[str, Any], None]) – The display mode of the single select question.
display_as (Optional[str]) – The display mode of the single select question. Allowed values : DROPDOWN | RADIO

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

evaluation_form_single_select_question_properties_property = 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"
)

Attributes

automation

The display mode of the single select question.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionproperties.html#cfn-connect-evaluationform-evaluationformsingleselectquestionproperties-automation

display_as

The display mode of the single select question.

Allowed values : DROPDOWN | RADIO

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionproperties.html#cfn-connect-evaluationform-evaluationformsingleselectquestionproperties-displayas

options

The answer options of the single select question.

Minimum : 2

Maximum : 256

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionproperties.html#cfn-connect-evaluationform-evaluationformsingleselectquestionproperties-options

NumericQuestionPropertyValueAutomationProperty

class CfnEvaluationForm.NumericQuestionPropertyValueAutomationProperty(*, label)

Bases: object

Information about the property value used in automation of a numeric questions.

Parameters:: label (str) – The property label of the automation. Allowed values : OVERALL_CUSTOMER_SENTIMENT_SCORE , OVERALL_AGENT_SENTIMENT_SCORE | NON_TALK_TIME | NON_TALK_TIME_PERCENTAGE | NUMBER_OF_INTERRUPTIONS | CONTACT_DURATION | AGENT_INTERACTION_DURATION | CUSTOMER_HOLD_TIME
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-numericquestionpropertyvalueautomation.html
ExampleMetadata:: fixture=_generated

Example:

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

numeric_question_property_value_automation_property = connect.CfnEvaluationForm.NumericQuestionPropertyValueAutomationProperty(
    label="label"
)

Attributes

label

The property label of the automation.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-numericquestionpropertyvalueautomation.html#cfn-connect-evaluationform-numericquestionpropertyvalueautomation-label

ScoringStrategyProperty

class CfnEvaluationForm.ScoringStrategyProperty(*, mode, status)

Bases: object

A scoring strategy of the evaluation form.

Parameters:

mode (str) – The scoring mode of the evaluation form. Allowed values : QUESTION_ONLY | SECTION_ONLY
status (str) – The scoring status of the evaluation form. Allowed values : ENABLED | DISABLED

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

scoring_strategy_property = connect.CfnEvaluationForm.ScoringStrategyProperty(
    mode="mode",
    status="status"
)

Attributes

mode

The scoring mode of the evaluation form.

Allowed values : QUESTION_ONLY | SECTION_ONLY

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

status

The scoring status of the evaluation form.

Allowed values : ENABLED | DISABLED

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

SingleSelectQuestionRuleCategoryAutomationProperty

class CfnEvaluationForm.SingleSelectQuestionRuleCategoryAutomationProperty(*, category, condition, option_ref_id)

Bases: object

Information about the automation option based on a rule category for a single select question.

Length Constraints : Minimum length of 1. Maximum length of 50.

Parameters:

category (str) – The category name, as defined in Rules. Minimum : 1 Maximum : 50
condition (str) – The condition to apply for the automation option. If the condition is PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT, then the option is applied when the contact data does not include the category. Allowed values : PRESENT | NOT_PRESENT Maximum : 50
option_ref_id (str) – The identifier of the answer option. An identifier must be unique within the question. Length Constraints : Minimum length of 1. Maximum length of 40.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

single_select_question_rule_category_automation_property = connect.CfnEvaluationForm.SingleSelectQuestionRuleCategoryAutomationProperty(
    category="category",
    condition="condition",
    option_ref_id="optionRefId"
)

Attributes

category

The category name, as defined in Rules.

Minimum : 1

Maximum : 50

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-singleselectquestionrulecategoryautomation.html#cfn-connect-evaluationform-singleselectquestionrulecategoryautomation-category

condition

The condition to apply for the automation option.

If the condition is PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT, then the option is applied when the contact data does not include the category.

Allowed values : PRESENT | NOT_PRESENT

Maximum : 50

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-singleselectquestionrulecategoryautomation.html#cfn-connect-evaluationform-singleselectquestionrulecategoryautomation-condition

option_ref_id

The identifier of the answer option. An identifier must be unique within the question.

Length Constraints : Minimum length of 1. Maximum length of 40.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-singleselectquestionrulecategoryautomation.html#cfn-connect-evaluationform-singleselectquestionrulecategoryautomation-optionrefid