Show / Hide Table of Contents

Class CfnEvaluationFormProps

Properties for defining a CfnEvaluationForm.

Inheritance
object
CfnEvaluationFormProps
Implements
ICfnEvaluationFormProps
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.Connect
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnEvaluationFormProps : ICfnEvaluationFormProps
Syntax (vb)
Public Class CfnEvaluationFormProps Implements ICfnEvaluationFormProps
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Connect;

             EvaluationFormSectionProperty evaluationFormSectionProperty_;

             var cfnEvaluationFormProps = new CfnEvaluationFormProps {
                 InstanceArn = "instanceArn",
                 Items = new [] { new EvaluationFormBaseItemProperty {
                     Section = new EvaluationFormSectionProperty {
                         RefId = "refId",
                         Title = "title",

                         // the properties below are optional
                         Instructions = "instructions",
                         Items = new [] { new EvaluationFormItemProperty {
                             Question = new EvaluationFormQuestionProperty {
                                 QuestionType = "questionType",
                                 RefId = "refId",
                                 Title = "title",

                                 // the properties below are optional
                                 Enablement = new EvaluationFormItemEnablementConfigurationProperty {
                                     Action = "action",
                                     Condition = new EvaluationFormItemEnablementConditionProperty {
                                         Operands = new [] { new EvaluationFormItemEnablementConditionOperandProperty {
                                             Expression = new EvaluationFormItemEnablementExpressionProperty {
                                                 Comparator = "comparator",
                                                 Source = new EvaluationFormItemEnablementSourceProperty {
                                                     Type = "type",

                                                     // the properties below are optional
                                                     RefId = "refId"
                                                 },
                                                 Values = new [] { new EvaluationFormItemEnablementSourceValueProperty {
                                                     RefId = "refId",
                                                     Type = "type"
                                                 } }
                                             }
                                         } },

                                         // the properties below are optional
                                         Operator = "operator"
                                     },

                                     // the properties below are optional
                                     DefaultAction = "defaultAction"
                                 },
                                 Instructions = "instructions",
                                 NotApplicableEnabled = false,
                                 QuestionTypeProperties = new EvaluationFormQuestionTypePropertiesProperty {
                                     MultiSelect = new EvaluationFormMultiSelectQuestionPropertiesProperty {
                                         Options = new [] { new EvaluationFormMultiSelectQuestionOptionProperty {
                                             RefId = "refId",
                                             Text = "text"
                                         } },

                                         // the properties below are optional
                                         Automation = new EvaluationFormMultiSelectQuestionAutomationProperty {
                                             Options = new [] { new EvaluationFormMultiSelectQuestionAutomationOptionProperty {
                                                 RuleCategory = new MultiSelectQuestionRuleCategoryAutomationProperty {
                                                     Category = "category",
                                                     Condition = "condition",
                                                     OptionRefIds = new [] { "optionRefIds" }
                                                 }
                                             } },

                                             // the properties below are optional
                                             AnswerSource = new EvaluationFormQuestionAutomationAnswerSourceProperty {
                                                 SourceType = "sourceType"
                                             },
                                             DefaultOptionRefIds = new [] { "defaultOptionRefIds" }
                                         },
                                         DisplayAs = "displayAs"
                                     },
                                     Numeric = new EvaluationFormNumericQuestionPropertiesProperty {
                                         MaxValue = 123,
                                         MinValue = 123,

                                         // the properties below are optional
                                         Automation = new EvaluationFormNumericQuestionAutomationProperty {
                                             AnswerSource = new EvaluationFormQuestionAutomationAnswerSourceProperty {
                                                 SourceType = "sourceType"
                                             },
                                             PropertyValue = new NumericQuestionPropertyValueAutomationProperty {
                                                 Label = "label"
                                             }
                                         },
                                         Options = new [] { new EvaluationFormNumericQuestionOptionProperty {
                                             MaxValue = 123,
                                             MinValue = 123,

                                             // the properties below are optional
                                             AutomaticFail = false,
                                             AutomaticFailConfiguration = new AutomaticFailConfigurationProperty {
                                                 TargetSection = "targetSection"
                                             },
                                             Score = 123
                                         } }
                                     },
                                     SingleSelect = new EvaluationFormSingleSelectQuestionPropertiesProperty {
                                         Options = new [] { new EvaluationFormSingleSelectQuestionOptionProperty {
                                             RefId = "refId",
                                             Text = "text",

                                             // the properties below are optional
                                             AutomaticFail = false,
                                             AutomaticFailConfiguration = new AutomaticFailConfigurationProperty {
                                                 TargetSection = "targetSection"
                                             },
                                             Score = 123
                                         } },

                                         // the properties below are optional
                                         Automation = new EvaluationFormSingleSelectQuestionAutomationProperty {
                                             Options = new [] { new EvaluationFormSingleSelectQuestionAutomationOptionProperty {
                                                 RuleCategory = new SingleSelectQuestionRuleCategoryAutomationProperty {
                                                     Category = "category",
                                                     Condition = "condition",
                                                     OptionRefId = "optionRefId"
                                                 }
                                             } },

                                             // the properties below are optional
                                             AnswerSource = new EvaluationFormQuestionAutomationAnswerSourceProperty {
                                                 SourceType = "sourceType"
                                             },
                                             DefaultOptionRefId = "defaultOptionRefId"
                                         },
                                         DisplayAs = "displayAs"
                                     },
                                     Text = new EvaluationFormTextQuestionPropertiesProperty {
                                         Automation = new EvaluationFormTextQuestionAutomationProperty {
                                             AnswerSource = new EvaluationFormQuestionAutomationAnswerSourceProperty {
                                                 SourceType = "sourceType"
                                             }
                                         }
                                     }
                                 },
                                 Weight = 123
                             },
                             Section = evaluationFormSectionProperty_
                         } },
                         Weight = 123
                     }
                 } },
                 Status = "status",
                 Title = "title",

                 // the properties below are optional
                 AutoEvaluationConfiguration = new AutoEvaluationConfigurationProperty {
                     Enabled = false
                 },
                 Description = "description",
                 LanguageConfiguration = new EvaluationFormLanguageConfigurationProperty {
                     FormLanguage = "formLanguage"
                 },
                 ReviewConfiguration = new EvaluationReviewConfigurationProperty {
                     ReviewNotificationRecipients = new [] { new EvaluationReviewNotificationRecipientProperty {
                         Type = "type",
                         Value = new EvaluationReviewNotificationRecipientValueProperty {
                             UserId = "userId"
                         }
                     } },

                     // the properties below are optional
                     EligibilityDays = 123
                 },
                 ScoringStrategy = new ScoringStrategyProperty {
                     Mode = "mode",
                     Status = "status"
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TargetConfiguration = new EvaluationFormTargetConfigurationProperty {
                     ContactInteractionType = "contactInteractionType"
                 }
             };

Synopsis

Constructors

CfnEvaluationFormProps()

Properties for defining a CfnEvaluationForm.

Properties

AutoEvaluationConfiguration

The automatic evaluation configuration of an evaluation form.

Description

The description of the evaluation form.

InstanceArn

The identifier of the Amazon Connect instance.

Items

Items that are part of the evaluation form.

LanguageConfiguration

Configuration for language settings of this evaluation form.

ReviewConfiguration

Configuration settings for evaluation reviews.

ScoringStrategy

A scoring strategy of the evaluation form.

Status

The status of the evaluation form.

Tags

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

TargetConfiguration

Configuration that specifies the target for this evaluation form.

Title

A title of the evaluation form.

Constructors

CfnEvaluationFormProps()

Properties for defining a CfnEvaluationForm.

public CfnEvaluationFormProps()
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Connect;

             EvaluationFormSectionProperty evaluationFormSectionProperty_;

             var cfnEvaluationFormProps = new CfnEvaluationFormProps {
                 InstanceArn = "instanceArn",
                 Items = new [] { new EvaluationFormBaseItemProperty {
                     Section = new EvaluationFormSectionProperty {
                         RefId = "refId",
                         Title = "title",

                         // the properties below are optional
                         Instructions = "instructions",
                         Items = new [] { new EvaluationFormItemProperty {
                             Question = new EvaluationFormQuestionProperty {
                                 QuestionType = "questionType",
                                 RefId = "refId",
                                 Title = "title",

                                 // the properties below are optional
                                 Enablement = new EvaluationFormItemEnablementConfigurationProperty {
                                     Action = "action",
                                     Condition = new EvaluationFormItemEnablementConditionProperty {
                                         Operands = new [] { new EvaluationFormItemEnablementConditionOperandProperty {
                                             Expression = new EvaluationFormItemEnablementExpressionProperty {
                                                 Comparator = "comparator",
                                                 Source = new EvaluationFormItemEnablementSourceProperty {
                                                     Type = "type",

                                                     // the properties below are optional
                                                     RefId = "refId"
                                                 },
                                                 Values = new [] { new EvaluationFormItemEnablementSourceValueProperty {
                                                     RefId = "refId",
                                                     Type = "type"
                                                 } }
                                             }
                                         } },

                                         // the properties below are optional
                                         Operator = "operator"
                                     },

                                     // the properties below are optional
                                     DefaultAction = "defaultAction"
                                 },
                                 Instructions = "instructions",
                                 NotApplicableEnabled = false,
                                 QuestionTypeProperties = new EvaluationFormQuestionTypePropertiesProperty {
                                     MultiSelect = new EvaluationFormMultiSelectQuestionPropertiesProperty {
                                         Options = new [] { new EvaluationFormMultiSelectQuestionOptionProperty {
                                             RefId = "refId",
                                             Text = "text"
                                         } },

                                         // the properties below are optional
                                         Automation = new EvaluationFormMultiSelectQuestionAutomationProperty {
                                             Options = new [] { new EvaluationFormMultiSelectQuestionAutomationOptionProperty {
                                                 RuleCategory = new MultiSelectQuestionRuleCategoryAutomationProperty {
                                                     Category = "category",
                                                     Condition = "condition",
                                                     OptionRefIds = new [] { "optionRefIds" }
                                                 }
                                             } },

                                             // the properties below are optional
                                             AnswerSource = new EvaluationFormQuestionAutomationAnswerSourceProperty {
                                                 SourceType = "sourceType"
                                             },
                                             DefaultOptionRefIds = new [] { "defaultOptionRefIds" }
                                         },
                                         DisplayAs = "displayAs"
                                     },
                                     Numeric = new EvaluationFormNumericQuestionPropertiesProperty {
                                         MaxValue = 123,
                                         MinValue = 123,

                                         // the properties below are optional
                                         Automation = new EvaluationFormNumericQuestionAutomationProperty {
                                             AnswerSource = new EvaluationFormQuestionAutomationAnswerSourceProperty {
                                                 SourceType = "sourceType"
                                             },
                                             PropertyValue = new NumericQuestionPropertyValueAutomationProperty {
                                                 Label = "label"
                                             }
                                         },
                                         Options = new [] { new EvaluationFormNumericQuestionOptionProperty {
                                             MaxValue = 123,
                                             MinValue = 123,

                                             // the properties below are optional
                                             AutomaticFail = false,
                                             AutomaticFailConfiguration = new AutomaticFailConfigurationProperty {
                                                 TargetSection = "targetSection"
                                             },
                                             Score = 123
                                         } }
                                     },
                                     SingleSelect = new EvaluationFormSingleSelectQuestionPropertiesProperty {
                                         Options = new [] { new EvaluationFormSingleSelectQuestionOptionProperty {
                                             RefId = "refId",
                                             Text = "text",

                                             // the properties below are optional
                                             AutomaticFail = false,
                                             AutomaticFailConfiguration = new AutomaticFailConfigurationProperty {
                                                 TargetSection = "targetSection"
                                             },
                                             Score = 123
                                         } },

                                         // the properties below are optional
                                         Automation = new EvaluationFormSingleSelectQuestionAutomationProperty {
                                             Options = new [] { new EvaluationFormSingleSelectQuestionAutomationOptionProperty {
                                                 RuleCategory = new SingleSelectQuestionRuleCategoryAutomationProperty {
                                                     Category = "category",
                                                     Condition = "condition",
                                                     OptionRefId = "optionRefId"
                                                 }
                                             } },

                                             // the properties below are optional
                                             AnswerSource = new EvaluationFormQuestionAutomationAnswerSourceProperty {
                                                 SourceType = "sourceType"
                                             },
                                             DefaultOptionRefId = "defaultOptionRefId"
                                         },
                                         DisplayAs = "displayAs"
                                     },
                                     Text = new EvaluationFormTextQuestionPropertiesProperty {
                                         Automation = new EvaluationFormTextQuestionAutomationProperty {
                                             AnswerSource = new EvaluationFormQuestionAutomationAnswerSourceProperty {
                                                 SourceType = "sourceType"
                                             }
                                         }
                                     }
                                 },
                                 Weight = 123
                             },
                             Section = evaluationFormSectionProperty_
                         } },
                         Weight = 123
                     }
                 } },
                 Status = "status",
                 Title = "title",

                 // the properties below are optional
                 AutoEvaluationConfiguration = new AutoEvaluationConfigurationProperty {
                     Enabled = false
                 },
                 Description = "description",
                 LanguageConfiguration = new EvaluationFormLanguageConfigurationProperty {
                     FormLanguage = "formLanguage"
                 },
                 ReviewConfiguration = new EvaluationReviewConfigurationProperty {
                     ReviewNotificationRecipients = new [] { new EvaluationReviewNotificationRecipientProperty {
                         Type = "type",
                         Value = new EvaluationReviewNotificationRecipientValueProperty {
                             UserId = "userId"
                         }
                     } },

                     // the properties below are optional
                     EligibilityDays = 123
                 },
                 ScoringStrategy = new ScoringStrategyProperty {
                     Mode = "mode",
                     Status = "status"
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TargetConfiguration = new EvaluationFormTargetConfigurationProperty {
                     ContactInteractionType = "contactInteractionType"
                 }
             };

Properties

AutoEvaluationConfiguration

The automatic evaluation configuration of an evaluation form.

public object? AutoEvaluationConfiguration { get; set; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnEvaluationForm.IAutoEvaluationConfigurationProperty

Description

The description of the evaluation form.

public string? Description { get; set; }
Property Value

string

Remarks

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

InstanceArn

The identifier of the Amazon Connect instance.

public object InstanceArn { get; set; }
Property Value

object

Remarks

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

Type union: either string or IInstanceRef

Items

Items that are part of the evaluation form.

public object Items { get; set; }
Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnEvaluationForm.IEvaluationFormBaseItemProperty)[]

LanguageConfiguration

Configuration for language settings of this evaluation form.

public object? LanguageConfiguration { get; set; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnEvaluationForm.IEvaluationFormLanguageConfigurationProperty

ReviewConfiguration

Configuration settings for evaluation reviews.

public object? ReviewConfiguration { get; set; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnEvaluationForm.IEvaluationReviewConfigurationProperty

ScoringStrategy

A scoring strategy of the evaluation form.

public object? ScoringStrategy { get; set; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnEvaluationForm.IScoringStrategyProperty

Status

The status of the evaluation form.

public string Status { get; set; }
Property Value

string

Remarks

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.

public ICfnTag[]? Tags { get; set; }
Property Value

ICfnTag[]

Remarks

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

TargetConfiguration

Configuration that specifies the target for this evaluation form.

public object? TargetConfiguration { get; set; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnEvaluationForm.IEvaluationFormTargetConfigurationProperty

Title

A title of the evaluation form.

public string Title { get; set; }
Property Value

string

Remarks

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

Implements

ICfnEvaluationFormProps
Back to top Generated by DocFX