aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
1,039 lines • 316 kB
TypeScript
import * as cdk from "../../core/lib";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
import { aws_connect as connectRefs } from "../../interfaces";
import { AgentStatusReference, ApprovedOriginReference, ContactFlowModuleReference, ContactFlowReference, ContactFlowVersionReference, DataTableAttributeReference, DataTableRecordReference, DataTableReference, EmailAddressReference, EvaluationFormReference, HoursOfOperationReference, IAgentStatusRef, IApprovedOriginRef, IContactFlowModuleRef, IContactFlowRef, IContactFlowVersionRef, IDataTableAttributeRef, IDataTableRecordRef, IDataTableRef, IEmailAddressRef, IEvaluationFormRef, IHoursOfOperationRef, IInstanceRef, IInstanceStorageConfigRef, IIntegrationAssociationRef, InstanceReference, InstanceStorageConfigReference, IntegrationAssociationReference, IPhoneNumberRef, IPredefinedAttributeRef, IPromptRef, IQueueRef, IQuickConnectRef, IRoutingProfileRef, IRuleRef, ISecurityKeyRef, ISecurityProfileRef, ITaskTemplateRef, ITrafficDistributionGroupRef, IUserHierarchyGroupRef, IUserHierarchyStructureRef, IUserRef, IViewRef, IViewVersionRef, IWorkspaceRef, PhoneNumberReference, PredefinedAttributeReference, PromptReference, QueueReference, QuickConnectReference, RoutingProfileReference, RuleReference, SecurityKeyReference, SecurityProfileReference, TaskTemplateReference, TrafficDistributionGroupReference, UserHierarchyGroupReference, UserHierarchyStructureReference, UserReference, ViewReference, ViewVersionReference, WorkspaceReference } from "../../interfaces/generated/aws-connect-interfaces.generated";
/**
* The approved origin for the instance.
*
* @cloudformationResource AWS::Connect::ApprovedOrigin
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-approvedorigin.html
*/
export declare class CfnApprovedOrigin extends cdk.CfnResource implements cdk.IInspectable, IApprovedOriginRef {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnApprovedOrigin from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnApprovedOrigin;
/**
* Checks whether the given object is a CfnApprovedOrigin
*/
static isCfnApprovedOrigin(x: any): x is CfnApprovedOrigin;
/**
* The Amazon Resource Name (ARN) of the instance.
*/
instanceId: string;
/**
* Domain name to be added to the allow-list of the instance.
*/
origin: string;
/**
* Create a new `AWS::Connect::ApprovedOrigin`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnApprovedOriginProps);
get approvedOriginRef(): ApprovedOriginReference;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
/**
* Properties for defining a `CfnApprovedOrigin`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-approvedorigin.html
*/
export interface CfnApprovedOriginProps {
/**
* The Amazon Resource Name (ARN) of the instance.
*
* *Minimum* : `1`
*
* *Maximum* : `100`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-approvedorigin.html#cfn-connect-approvedorigin-instanceid
*/
readonly instanceId: connectRefs.IInstanceRef | string;
/**
* Domain name to be added to the allow-list of the instance.
*
* *Maximum* : `267`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-approvedorigin.html#cfn-connect-approvedorigin-origin
*/
readonly origin: string;
}
/**
* Specifies a flow for an Amazon Connect instance.
*
* @cloudformationResource AWS::Connect::ContactFlow
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-contactflow.html
*/
export declare class CfnContactFlow extends cdk.CfnResource implements cdk.IInspectable, IContactFlowRef, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnContactFlow from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnContactFlow;
/**
* Checks whether the given object is a CfnContactFlow
*/
static isCfnContactFlow(x: any): x is CfnContactFlow;
static arnForContactFlow(resource: IContactFlowRef): string;
/**
* `Ref` returns the Amazon Resource Name (ARN) of the flow.
*
* @cloudformationAttribute ContactFlowArn
*/
readonly attrContactFlowArn: string;
/**
* The content of the flow.
*/
content: string;
/**
* The description of the flow.
*/
description?: string;
/**
* The Amazon Resource Name (ARN) of the Amazon Connect instance.
*/
instanceArn: string;
/**
* The name of the flow.
*/
name: string;
/**
* The state of the flow.
*/
state?: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* An array of key-value pairs to apply to this resource.
*/
tagsRaw?: Array<cdk.CfnTag>;
/**
* The type of the flow.
*/
type: string;
/**
* Create a new `AWS::Connect::ContactFlow`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnContactFlowProps);
get contactFlowRef(): ContactFlowReference;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
/**
* Properties for defining a `CfnContactFlow`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-contactflow.html
*/
export interface CfnContactFlowProps {
/**
* The content of the flow.
*
* For more information, see [Amazon Connect Flow language](https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html) in the *Amazon Connect Administrator Guide* .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-contactflow.html#cfn-connect-contactflow-content
*/
readonly content: string;
/**
* The description of the flow.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-contactflow.html#cfn-connect-contactflow-description
*/
readonly description?: string;
/**
* The Amazon Resource Name (ARN) of the Amazon Connect instance.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-contactflow.html#cfn-connect-contactflow-instancearn
*/
readonly instanceArn: connectRefs.IInstanceRef | string;
/**
* The name of the flow.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-contactflow.html#cfn-connect-contactflow-name
*/
readonly name: string;
/**
* The state of the flow.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-contactflow.html#cfn-connect-contactflow-state
*/
readonly state?: string;
/**
* An array of key-value pairs to apply to this resource.
*
* For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-contactflow.html#cfn-connect-contactflow-tags
*/
readonly tags?: Array<cdk.CfnTag>;
/**
* The type of the flow.
*
* For descriptions of the available types, see [Choose a flow type](https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types) in the *Amazon Connect Administrator Guide* .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-contactflow.html#cfn-connect-contactflow-type
*/
readonly type: string;
}
/**
* Specifies a flow module for an Amazon Connect instance.
*
* @cloudformationResource AWS::Connect::ContactFlowModule
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-contactflowmodule.html
*/
export declare class CfnContactFlowModule extends cdk.CfnResource implements cdk.IInspectable, IContactFlowModuleRef, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnContactFlowModule from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnContactFlowModule;
/**
* Checks whether the given object is a CfnContactFlowModule
*/
static isCfnContactFlowModule(x: any): x is CfnContactFlowModule;
static arnForContactFlowModule(resource: IContactFlowModuleRef): string;
/**
* `Ref` returns the Amazon Resource Name (ARN) of the flow module.
*
* @cloudformationAttribute ContactFlowModuleArn
*/
readonly attrContactFlowModuleArn: string;
/**
* The status of the contact flow module.
*
* @cloudformationAttribute Status
*/
readonly attrStatus: string;
/**
* The content of the flow module.
*/
content: string;
/**
* The description of the flow module.
*/
description?: string;
/**
* The Amazon Resource Name (ARN) of the Amazon Connect instance.
*/
instanceArn: string;
/**
* The name of the flow module.
*/
name: string;
/**
* The state of the flow module.
*/
state?: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* An array of key-value pairs to apply to this resource.
*/
tagsRaw?: Array<cdk.CfnTag>;
/**
* Create a new `AWS::Connect::ContactFlowModule`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnContactFlowModuleProps);
get contactFlowModuleRef(): ContactFlowModuleReference;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
/**
* Properties for defining a `CfnContactFlowModule`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-contactflowmodule.html
*/
export interface CfnContactFlowModuleProps {
/**
* The content of the flow module.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-contactflowmodule.html#cfn-connect-contactflowmodule-content
*/
readonly content: string;
/**
* The description of the flow module.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-contactflowmodule.html#cfn-connect-contactflowmodule-description
*/
readonly description?: string;
/**
* The Amazon Resource Name (ARN) of the Amazon Connect instance.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-contactflowmodule.html#cfn-connect-contactflowmodule-instancearn
*/
readonly instanceArn: connectRefs.IInstanceRef | string;
/**
* The name of the flow module.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-contactflowmodule.html#cfn-connect-contactflowmodule-name
*/
readonly name: string;
/**
* The state of the flow module.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-contactflowmodule.html#cfn-connect-contactflowmodule-state
*/
readonly state?: string;
/**
* An array of key-value pairs to apply to this resource.
*
* For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-contactflowmodule.html#cfn-connect-contactflowmodule-tags
*/
readonly tags?: Array<cdk.CfnTag>;
}
/**
* Creates an evaluation form for the specified Amazon Connect instance.
*
* @cloudformationResource AWS::Connect::EvaluationForm
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-evaluationform.html
*/
export declare class CfnEvaluationForm extends cdk.CfnResource implements cdk.IInspectable, IEvaluationFormRef, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnEvaluationForm from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnEvaluationForm;
/**
* Checks whether the given object is a CfnEvaluationForm
*/
static isCfnEvaluationForm(x: any): x is CfnEvaluationForm;
static arnForEvaluationForm(resource: IEvaluationFormRef): string;
/**
* The Amazon Resource Name (ARN) of the evaluation form.
*
* @cloudformationAttribute EvaluationFormArn
*/
readonly attrEvaluationFormArn: string;
/**
* The automatic evaluation configuration of an evaluation form.
*/
autoEvaluationConfiguration?: CfnEvaluationForm.AutoEvaluationConfigurationProperty | cdk.IResolvable;
/**
* The description of the evaluation form.
*/
description?: string;
/**
* The identifier of the Amazon Connect instance.
*/
instanceArn: string;
/**
* Items that are part of the evaluation form.
*/
items: Array<CfnEvaluationForm.EvaluationFormBaseItemProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* Configuration for language settings of this evaluation form.
*/
languageConfiguration?: CfnEvaluationForm.EvaluationFormLanguageConfigurationProperty | cdk.IResolvable;
/**
* A scoring strategy of the evaluation form.
*/
scoringStrategy?: cdk.IResolvable | CfnEvaluationForm.ScoringStrategyProperty;
/**
* The status of the evaluation form.
*/
status: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* The tags used to organize, track, or control access for this resource.
*/
tagsRaw?: Array<cdk.CfnTag>;
/**
* Configuration that specifies the target for this evaluation form.
*/
targetConfiguration?: CfnEvaluationForm.EvaluationFormTargetConfigurationProperty | cdk.IResolvable;
/**
* A title of the evaluation form.
*/
title: string;
/**
* Create a new `AWS::Connect::EvaluationForm`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnEvaluationFormProps);
get evaluationFormRef(): EvaluationFormReference;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnEvaluationForm {
/**
* A scoring strategy of the evaluation form.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-scoringstrategy.html
*/
interface ScoringStrategyProperty {
/**
* The scoring mode of the evaluation form.
*
* *Allowed values* : `QUESTION_ONLY` | `SECTION_ONLY`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-scoringstrategy.html#cfn-connect-evaluationform-scoringstrategy-mode
*/
readonly mode: string;
/**
* The scoring status of the evaluation form.
*
* *Allowed values* : `ENABLED` | `DISABLED`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-scoringstrategy.html#cfn-connect-evaluationform-scoringstrategy-status
*/
readonly status: string;
}
/**
* An item at the root level.
*
* All items must be sections.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformbaseitem.html
*/
interface EvaluationFormBaseItemProperty {
/**
* A subsection or inner section of an item.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformbaseitem.html#cfn-connect-evaluationform-evaluationformbaseitem-section
*/
readonly section: CfnEvaluationForm.EvaluationFormSectionProperty | cdk.IResolvable;
}
/**
* 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).
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsection.html
*/
interface EvaluationFormSectionProperty {
/**
* The instructions of the section.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsection.html#cfn-connect-evaluationform-evaluationformsection-instructions
*/
readonly instructions?: string;
/**
* The items of the section.
*
* *Minimum* : 1
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsection.html#cfn-connect-evaluationform-evaluationformsection-items
*/
readonly items?: Array<CfnEvaluationForm.EvaluationFormItemProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* The identifier of the section. An identifier must be unique within the evaluation form.
*
* *Length Constraints* : Minimum length of 1. Maximum length of 40.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsection.html#cfn-connect-evaluationform-evaluationformsection-refid
*/
readonly refId: string;
/**
* The title of the section.
*
* *Length Constraints* : Minimum length of 1. Maximum length of 128.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsection.html#cfn-connect-evaluationform-evaluationformsection-title
*/
readonly title: string;
/**
* The scoring weight of the section.
*
* *Minimum* : 0
*
* *Maximum* : 100
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsection.html#cfn-connect-evaluationform-evaluationformsection-weight
*/
readonly weight?: number;
}
/**
* 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.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformitem.html
*/
interface EvaluationFormItemProperty {
/**
* The information of the question.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformitem.html#cfn-connect-evaluationform-evaluationformitem-question
*/
readonly question?: CfnEvaluationForm.EvaluationFormQuestionProperty | cdk.IResolvable;
/**
* The information of the section.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformitem.html#cfn-connect-evaluationform-evaluationformitem-section
*/
readonly section?: CfnEvaluationForm.EvaluationFormSectionProperty | cdk.IResolvable;
}
/**
* Information about a question from an evaluation form.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformquestion.html
*/
interface EvaluationFormQuestionProperty {
/**
* A question conditional enablement.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformquestion.html#cfn-connect-evaluationform-evaluationformquestion-enablement
*/
readonly enablement?: CfnEvaluationForm.EvaluationFormItemEnablementConfigurationProperty | cdk.IResolvable;
/**
* The instructions of the section.
*
* *Length Constraints* : Minimum length of 0. Maximum length of 1024.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformquestion.html#cfn-connect-evaluationform-evaluationformquestion-instructions
*/
readonly instructions?: string;
/**
* The flag to enable not applicable answers to the question.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformquestion.html#cfn-connect-evaluationform-evaluationformquestion-notapplicableenabled
*/
readonly notApplicableEnabled?: boolean | cdk.IResolvable;
/**
* The type of the question.
*
* *Allowed values* : `NUMERIC` | `SINGLESELECT` | `TEXT`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformquestion.html#cfn-connect-evaluationform-evaluationformquestion-questiontype
*/
readonly questionType: string;
/**
* The properties of the type of question.
*
* Text questions do not have to define question type properties.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformquestion.html#cfn-connect-evaluationform-evaluationformquestion-questiontypeproperties
*/
readonly questionTypeProperties?: CfnEvaluationForm.EvaluationFormQuestionTypePropertiesProperty | cdk.IResolvable;
/**
* The identifier of the question. An identifier must be unique within the evaluation form.
*
* *Length Constraints* : Minimum length of 1. Maximum length of 40.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformquestion.html#cfn-connect-evaluationform-evaluationformquestion-refid
*/
readonly refId: string;
/**
* The title of the question.
*
* *Length Constraints* : Minimum length of 1. Maximum length of 350.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformquestion.html#cfn-connect-evaluationform-evaluationformquestion-title
*/
readonly title: string;
/**
* The scoring weight of the section.
*
* *Minimum* : 0
*
* *Maximum* : 100
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformquestion.html#cfn-connect-evaluationform-evaluationformquestion-weight
*/
readonly weight?: number;
}
/**
* 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.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformquestiontypeproperties.html
*/
interface EvaluationFormQuestionTypePropertiesProperty {
/**
* Properties for multi-select question types.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformquestiontypeproperties.html#cfn-connect-evaluationform-evaluationformquestiontypeproperties-multiselect
*/
readonly multiSelect?: CfnEvaluationForm.EvaluationFormMultiSelectQuestionPropertiesProperty | cdk.IResolvable;
/**
* The properties of the numeric question.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformquestiontypeproperties.html#cfn-connect-evaluationform-evaluationformquestiontypeproperties-numeric
*/
readonly numeric?: CfnEvaluationForm.EvaluationFormNumericQuestionPropertiesProperty | cdk.IResolvable;
/**
* The properties of the numeric question.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformquestiontypeproperties.html#cfn-connect-evaluationform-evaluationformquestiontypeproperties-singleselect
*/
readonly singleSelect?: CfnEvaluationForm.EvaluationFormSingleSelectQuestionPropertiesProperty | cdk.IResolvable;
/**
* The properties of the text question.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformquestiontypeproperties.html#cfn-connect-evaluationform-evaluationformquestiontypeproperties-text
*/
readonly text?: CfnEvaluationForm.EvaluationFormTextQuestionPropertiesProperty | cdk.IResolvable;
}
/**
* Information about properties for a numeric question in an evaluation form.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformnumericquestionproperties.html
*/
interface EvaluationFormNumericQuestionPropertiesProperty {
/**
* The automation properties of the numeric question.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformnumericquestionproperties.html#cfn-connect-evaluationform-evaluationformnumericquestionproperties-automation
*/
readonly automation?: CfnEvaluationForm.EvaluationFormNumericQuestionAutomationProperty | cdk.IResolvable;
/**
* The maximum answer value.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformnumericquestionproperties.html#cfn-connect-evaluationform-evaluationformnumericquestionproperties-maxvalue
*/
readonly maxValue: number;
/**
* The minimum answer value.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformnumericquestionproperties.html#cfn-connect-evaluationform-evaluationformnumericquestionproperties-minvalue
*/
readonly minValue: number;
/**
* The scoring options of the numeric question.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformnumericquestionproperties.html#cfn-connect-evaluationform-evaluationformnumericquestionproperties-options
*/
readonly options?: Array<CfnEvaluationForm.EvaluationFormNumericQuestionOptionProperty | cdk.IResolvable> | cdk.IResolvable;
}
/**
* Information about the option range used for scoring in numeric questions.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformnumericquestionoption.html
*/
interface EvaluationFormNumericQuestionOptionProperty {
/**
* The flag to mark the option as automatic fail.
*
* If an automatic fail answer is provided, the overall evaluation gets a score of 0.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformnumericquestionoption.html#cfn-connect-evaluationform-evaluationformnumericquestionoption-automaticfail
*/
readonly automaticFail?: boolean | cdk.IResolvable;
/**
* A configuration for automatic fail.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformnumericquestionoption.html#cfn-connect-evaluationform-evaluationformnumericquestionoption-automaticfailconfiguration
*/
readonly automaticFailConfiguration?: CfnEvaluationForm.AutomaticFailConfigurationProperty | cdk.IResolvable;
/**
* The maximum answer value of the range option.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformnumericquestionoption.html#cfn-connect-evaluationform-evaluationformnumericquestionoption-maxvalue
*/
readonly maxValue: number;
/**
* The minimum answer value of the range option.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformnumericquestionoption.html#cfn-connect-evaluationform-evaluationformnumericquestionoption-minvalue
*/
readonly minValue: number;
/**
* The score assigned to answer values within the range option.
*
* *Minimum* : 0
*
* *Maximum* : 10
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformnumericquestionoption.html#cfn-connect-evaluationform-evaluationformnumericquestionoption-score
*/
readonly score?: number;
}
/**
* Information about automatic fail configuration for an evaluation form.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-automaticfailconfiguration.html
*/
interface AutomaticFailConfigurationProperty {
/**
* The referenceId of the target section for auto failure.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-automaticfailconfiguration.html#cfn-connect-evaluationform-automaticfailconfiguration-targetsection
*/
readonly targetSection?: string;
}
/**
* Information about the automation configuration in numeric questions.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformnumericquestionautomation.html
*/
interface EvaluationFormNumericQuestionAutomationProperty {
/**
* A source of automation answer for numeric question.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformnumericquestionautomation.html#cfn-connect-evaluationform-evaluationformnumericquestionautomation-answersource
*/
readonly answerSource?: CfnEvaluationForm.EvaluationFormQuestionAutomationAnswerSourceProperty | cdk.IResolvable;
/**
* The property value of the automation.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformnumericquestionautomation.html#cfn-connect-evaluationform-evaluationformnumericquestionautomation-propertyvalue
*/
readonly propertyValue?: cdk.IResolvable | CfnEvaluationForm.NumericQuestionPropertyValueAutomationProperty;
}
/**
* Information about the property value used in automation of a numeric questions.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-numericquestionpropertyvalueautomation.html
*/
interface NumericQuestionPropertyValueAutomationProperty {
/**
* The property label of the automation.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-numericquestionpropertyvalueautomation.html#cfn-connect-evaluationform-numericquestionpropertyvalueautomation-label
*/
readonly label: string;
}
/**
* A question automation answer.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformquestionautomationanswersource.html
*/
interface EvaluationFormQuestionAutomationAnswerSourceProperty {
/**
* The automation answer source type.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformquestionautomationanswersource.html#cfn-connect-evaluationform-evaluationformquestionautomationanswersource-sourcetype
*/
readonly sourceType: string;
}
/**
* Information about the options in single select questions.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionproperties.html
*/
interface EvaluationFormSingleSelectQuestionPropertiesProperty {
/**
* The display mode of the single select question.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionproperties.html#cfn-connect-evaluationform-evaluationformsingleselectquestionproperties-automation
*/
readonly automation?: CfnEvaluationForm.EvaluationFormSingleSelectQuestionAutomationProperty | cdk.IResolvable;
/**
* The display mode of the single select question.
*
* *Allowed values* : `DROPDOWN` | `RADIO`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionproperties.html#cfn-connect-evaluationform-evaluationformsingleselectquestionproperties-displayas
*/
readonly displayAs?: string;
/**
* The answer options of the single select question.
*
* *Minimum* : 2
*
* *Maximum* : 256
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionproperties.html#cfn-connect-evaluationform-evaluationformsingleselectquestionproperties-options
*/
readonly options: Array<CfnEvaluationForm.EvaluationFormSingleSelectQuestionOptionProperty | cdk.IResolvable> | cdk.IResolvable;
}
/**
* Information about the automation configuration in single select questions.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionoption.html
*/
interface EvaluationFormSingleSelectQuestionOptionProperty {
/**
* The flag to mark the option as automatic fail.
*
* If an automatic fail answer is provided, the overall evaluation gets a score of 0.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionoption.html#cfn-connect-evaluationform-evaluationformsingleselectquestionoption-automaticfail
*/
readonly automaticFail?: boolean | cdk.IResolvable;
/**
* Whether automatic fail is configured on a single select question.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionoption.html#cfn-connect-evaluationform-evaluationformsingleselectquestionoption-automaticfailconfiguration
*/
readonly automaticFailConfiguration?: CfnEvaluationForm.AutomaticFailConfigurationProperty | cdk.IResolvable;
/**
* The identifier of the answer option. An identifier must be unique within the question.
*
* *Length Constraints* : Minimum length of 1. Maximum length of 40.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionoption.html#cfn-connect-evaluationform-evaluationformsingleselectquestionoption-refid
*/
readonly refId: string;
/**
* The score assigned to the answer option.
*
* *Minimum* : 0
*
* *Maximum* : 10
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionoption.html#cfn-connect-evaluationform-evaluationformsingleselectquestionoption-score
*/
readonly score?: number;
/**
* The title of the answer option.
*
* *Length Constraints* : Minimum length of 1. Maximum length of 128.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionoption.html#cfn-connect-evaluationform-evaluationformsingleselectquestionoption-text
*/
readonly text: string;
}
/**
* 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.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionautomation.html
*/
interface EvaluationFormSingleSelectQuestionAutomationProperty {
/**
* Automation answer source.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionautomation.html#cfn-connect-evaluationform-evaluationformsingleselectquestionautomation-answersource
*/
readonly answerSource?: CfnEvaluationForm.EvaluationFormQuestionAutomationAnswerSourceProperty | cdk.IResolvable;
/**
* 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.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionautomation.html#cfn-connect-evaluationform-evaluationformsingleselectquestionautomation-defaultoptionrefid
*/
readonly defaultOptionRefId?: string;
/**
* The automation options of the single select question.
*
* *Minimum* : 1
*
* *Maximum* : 20
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionautomation.html#cfn-connect-evaluationform-evaluationformsingleselectquestionautomation-options
*/
readonly options: Array<CfnEvaluationForm.EvaluationFormSingleSelectQuestionAutomationOptionProperty | cdk.IResolvable> | cdk.IResolvable;
}
/**
* The automation options of the single select question.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionautomationoption.html
*/
interface EvaluationFormSingleSelectQuestionAutomationOptionProperty {
/**
* The automation option based on a rule category for the single select question.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformsingleselectquestionautomationoption.html#cfn-connect-evaluationform-evaluationformsingleselectquestionautomationoption-rulecategory
*/
readonly ruleCategory: cdk.IResolvable | CfnEvaluationForm.SingleSelectQuestionRuleCategoryAutomationProperty;
}
/**
* 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.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-singleselectquestionrulecategoryautomation.html
*/
interface SingleSelectQuestionRuleCategoryAutomationProperty {
/**
* The category name, as defined in Rules.
*
* *Minimum* : 1
*
* *Maximum* : 50
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-singleselectquestionrulecategoryautomation.html#cfn-connect-evaluationform-singleselectquestionrulecategoryautomation-category
*/
readonly category: string;
/**
* 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
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-singleselectquestionrulecategoryautomation.html#cfn-connect-evaluationform-singleselectquestionrulecategoryautomation-condition
*/
readonly condition: string;
/**
* The identifier of the answer option. An identifier must be unique within the question.
*
* *Length Constraints* : Minimum length of 1. Maximum length of 40.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-singleselectquestionrulecategoryautomation.html#cfn-connect-evaluationform-singleselectquestionrulecategoryautomation-optionrefid
*/
readonly optionRefId: string;
}
/**
* Information about properties for a text question in an evaluation form.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformtextquestionproperties.html
*/
interface EvaluationFormTextQuestionPropertiesProperty {
/**
* The automation properties of the text question.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformtextquestionproperties.html#cfn-connect-evaluationform-evaluationformtextquestionproperties-automation
*/
readonly automation?: CfnEvaluationForm.EvaluationFormTextQuestionAutomationProperty | cdk.IResolvable;
}
/**
* Information about the automation configuration in text questions.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformtextquestionautomation.html
*/
interface EvaluationFormTextQuestionAutomationProperty {
/**
* Automation answer source.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformtextquestionautomation.html#cfn-connect-evaluationform-evaluationformtextquestionautomation-answersource
*/
readonly answerSource?: CfnEvaluationForm.EvaluationFormQuestionAutomationAnswerSourceProperty | cdk.IResolvable;
}
/**
* Properties for a multi-select question in an evaluation form.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformmultiselectquestionproperties.html
*/
interface EvaluationFormMultiSelectQuestionPropertiesProperty {
/**
* Automation configuration for this multi-select question.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformmultiselectquestionproperties.html#cfn-connect-evaluationform-evaluationformmultiselectquestionproperties-automation
*/
readonly automation?: CfnEvaluationForm.EvaluationFormMultiSelectQuestionAutomationProperty | cdk.IResolvable;
/**
* Display format for the multi-select question.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-evaluationform-evaluationformmultiselectquestionproperties.html#cfn-connect-evaluationform-evaluationformmultiselectquestion