Package software.amazon.awscdk.services.connect

Class CfnEvaluationForm

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.connect.CfnEvaluationForm

All Implemented Interfaces:

IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:55.940Z")
@Stability(Stable)
public class CfnEvaluationForm
extends CfnResource
implements IInspectable

A CloudFormation AWS::Connect::EvaluationForm.

Creates an evaluation form for the specified Amazon Connect instance.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.connect.*;
 EvaluationFormSectionProperty evaluationFormSectionProperty_;
 CfnEvaluationForm cfnEvaluationForm = CfnEvaluationForm.Builder.create(this, "MyCfnEvaluationForm")
         .instanceArn("instanceArn")
         .items(List.of(EvaluationFormBaseItemProperty.builder()
                 .section(EvaluationFormSectionProperty.builder()
                         .refId("refId")
                         .title("title")
                         // the properties below are optional
                         .instructions("instructions")
                         .items(List.of(EvaluationFormItemProperty.builder()
                                 .question(EvaluationFormQuestionProperty.builder()
                                         .questionType("questionType")
                                         .refId("refId")
                                         .title("title")
                                         // the properties below are optional
                                         .instructions("instructions")
                                         .notApplicableEnabled(false)
                                         .questionTypeProperties(EvaluationFormQuestionTypePropertiesProperty.builder()
                                                 .numeric(EvaluationFormNumericQuestionPropertiesProperty.builder()
                                                         .maxValue(123)
                                                         .minValue(123)
                                                         // the properties below are optional
                                                         .automation(EvaluationFormNumericQuestionAutomationProperty.builder()
                                                                 .propertyValue(NumericQuestionPropertyValueAutomationProperty.builder()
                                                                         .label("label")
                                                                         .build())
                                                                 .build())
                                                         .options(List.of(EvaluationFormNumericQuestionOptionProperty.builder()
                                                                 .maxValue(123)
                                                                 .minValue(123)
                                                                 // the properties below are optional
                                                                 .automaticFail(false)
                                                                 .score(123)
                                                                 .build()))
                                                         .build())
                                                 .singleSelect(EvaluationFormSingleSelectQuestionPropertiesProperty.builder()
                                                         .options(List.of(EvaluationFormSingleSelectQuestionOptionProperty.builder()
                                                                 .refId("refId")
                                                                 .text("text")
                                                                 // the properties below are optional
                                                                 .automaticFail(false)
                                                                 .score(123)
                                                                 .build()))
                                                         // the properties below are optional
                                                         .automation(EvaluationFormSingleSelectQuestionAutomationProperty.builder()
                                                                 .options(List.of(EvaluationFormSingleSelectQuestionAutomationOptionProperty.builder()
                                                                         .ruleCategory(SingleSelectQuestionRuleCategoryAutomationProperty.builder()
                                                                                 .category("category")
                                                                                 .condition("condition")
                                                                                 .optionRefId("optionRefId")
                                                                                 .build())
                                                                         .build()))
                                                                 // the properties below are optional
                                                                 .defaultOptionRefId("defaultOptionRefId")
                                                                 .build())
                                                         .displayAs("displayAs")
                                                         .build())
                                                 .build())
                                         .weight(123)
                                         .build())
                                 .section(evaluationFormSectionProperty_)
                                 .build()))
                         .weight(123)
                         .build())
                 .build()))
         .status("status")
         .title("title")
         // the properties below are optional
         .description("description")
         .scoringStrategy(ScoringStrategyProperty.builder()
                 .mode("mode")
                 .status("status")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnEvaluationForm.Builder	A fluent builder for CfnEvaluationForm.
static interface	CfnEvaluationForm.EvaluationFormBaseItemProperty	An item at the root level.
static interface	CfnEvaluationForm.EvaluationFormItemProperty	Items that are part of the evaluation form.
static interface	CfnEvaluationForm.EvaluationFormNumericQuestionAutomationProperty	Information about the automation configuration in numeric questions.
static interface	CfnEvaluationForm.EvaluationFormNumericQuestionOptionProperty	Information about the option range used for scoring in numeric questions.
static interface	CfnEvaluationForm.EvaluationFormNumericQuestionPropertiesProperty	Information about properties for a numeric question in an evaluation form.
static interface	CfnEvaluationForm.EvaluationFormQuestionProperty	Information about a question from an evaluation form.
static interface	CfnEvaluationForm.EvaluationFormQuestionTypePropertiesProperty	Information about properties for a question in an evaluation form.
static interface	CfnEvaluationForm.EvaluationFormSectionProperty	Information about a section from an evaluation form.
static interface	CfnEvaluationForm.EvaluationFormSingleSelectQuestionAutomationOptionProperty	The automation options of the single select question.
static interface	CfnEvaluationForm.EvaluationFormSingleSelectQuestionAutomationProperty	Information about the automation configuration in single select questions.
static interface	CfnEvaluationForm.EvaluationFormSingleSelectQuestionOptionProperty	Information about the automation configuration in single select questions.
static interface	CfnEvaluationForm.EvaluationFormSingleSelectQuestionPropertiesProperty	Information about the options in single select questions.
static interface	CfnEvaluationForm.NumericQuestionPropertyValueAutomationProperty	Information about the property value used in automation of a numeric questions.
static interface	CfnEvaluationForm.ScoringStrategyProperty	A scoring strategy of the evaluation form.
static interface	CfnEvaluationForm.SingleSelectQuestionRuleCategoryAutomationProperty	Information about the automation option based on a rule category for a single select question.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnEvaluationForm(Construct scope, String id, CfnEvaluationFormProps props)	Create a new AWS::Connect::EvaluationForm.
protected	CfnEvaluationForm(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEvaluationForm(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
String	getAttrEvaluationFormArn()	The Amazon Resource Name (ARN) of the evaluation form.
protected Map<String,Object>	getCfnProperties()
String	getDescription()	The description of the evaluation form.
String	getInstanceArn()	The identifier of the Amazon Connect instance.
Object	getItems()	Items that are part of the evaluation form.
Object	getScoringStrategy()	A scoring strategy of the evaluation form.
String	getStatus()	The status of the evaluation form.
TagManager	getTags()	The tags used to organize, track, or control access for this resource.
String	getTitle()	A title of the evaluation form.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value)	The description of the evaluation form.
void	setInstanceArn(String value)	The identifier of the Amazon Connect instance.
void	setItems(List<Object> value)	Items that are part of the evaluation form.
void	setItems(IResolvable value)	Items that are part of the evaluation form.
void	setScoringStrategy(IResolvable value)	A scoring strategy of the evaluation form.
void	setScoringStrategy(CfnEvaluationForm.ScoringStrategyProperty value)	A scoring strategy of the evaluation form.
void	setStatus(String value)	The status of the evaluation form.
void	setTitle(String value)	A title of the evaluation form.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnEvaluationForm

protected CfnEvaluationForm(software.amazon.jsii.JsiiObjectRef objRef)

CfnEvaluationForm

protected CfnEvaluationForm(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnEvaluationForm

@Stability(Stable)
public CfnEvaluationForm(@NotNull
 Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnEvaluationFormProps props)

Create a new AWS::Connect::EvaluationForm.

Parameters:

scope -

• scope in which this resource is defined.

This parameter is required.

id -

• scoped id of the resource.

This parameter is required.

props -

• resource properties.

This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector -

• tree inspector to collect and process attributes.

This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrEvaluationFormArn

@Stability(Stable)
@NotNull
public String getAttrEvaluationFormArn()

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

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

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

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

getInstanceArn

@Stability(Stable)
@NotNull
public String getInstanceArn()

The identifier of the Amazon Connect instance.

setInstanceArn

@Stability(Stable)
public void setInstanceArn(@NotNull
 String value)

The identifier of the Amazon Connect instance.

getItems

@Stability(Stable)
@NotNull
public Object getItems()

Items that are part of the evaluation form.

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

Minimum size : 1

Maximum size : 100

setItems

@Stability(Stable)
public void setItems(@NotNull
 IResolvable value)

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

setItems

@Stability(Stable)
public void setItems(@NotNull
 List<Object> value)

Items that are part of the evaluation form.

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

Minimum size : 1

Maximum size : 100

getStatus

@Stability(Stable)
@NotNull
public String getStatus()

The status of the evaluation form.

Allowed values : DRAFT | ACTIVE

setStatus

@Stability(Stable)
public void setStatus(@NotNull
 String value)

The status of the evaluation form.

Allowed values : DRAFT | ACTIVE

getTitle

@Stability(Stable)
@NotNull
public String getTitle()

A title of the evaluation form.

setTitle

@Stability(Stable)
public void setTitle(@NotNull
 String value)

A title of the evaluation form.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

The description of the evaluation form.

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

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The description of the evaluation form.

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

getScoringStrategy

@Stability(Stable)
@Nullable
public Object getScoringStrategy()

A scoring strategy of the evaluation form.

setScoringStrategy

@Stability(Stable)
public void setScoringStrategy(@Nullable
 IResolvable value)

A scoring strategy of the evaluation form.

setScoringStrategy

@Stability(Stable)
public void setScoringStrategy(@Nullable
 CfnEvaluationForm.ScoringStrategyProperty value)

A scoring strategy of the evaluation form.