Class: AWSCDK::Connect::CfnEvaluationFormProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
connect/cfn_evaluation_form_props.rb

Overview

Properties for defining a CfnEvaluationForm.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(instance_arn:, items:, status:, title:, auto_evaluation_configuration: nil, description: nil, language_configuration: nil, review_configuration: nil, scoring_strategy: nil, tags: nil, target_configuration: nil) ⇒ CfnEvaluationFormProps

Returns a new instance of CfnEvaluationFormProps.

Parameters:



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'connect/cfn_evaluation_form_props.rb', line 20

def initialize(instance_arn:, items:, status:, title:, auto_evaluation_configuration: nil, description: nil, language_configuration: nil, review_configuration: nil, scoring_strategy: nil, tags: nil, target_configuration: nil)
  @instance_arn = instance_arn
  Jsii::Type.check_type(@instance_arn, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jb25uZWN0LklJbnN0YW5jZVJlZiJ9XX19")), "instanceArn")
  @items = items
  Jsii::Type.check_type(@items, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29ubmVjdC5DZm5FdmFsdWF0aW9uRm9ybS5FdmFsdWF0aW9uRm9ybUJhc2VJdGVtUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "items")
  @status = status
  Jsii::Type.check_type(@status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status")
  @title = title
  Jsii::Type.check_type(@title, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "title")
  @auto_evaluation_configuration = auto_evaluation_configuration.is_a?(Hash) ? ::AWSCDK::Connect::CfnEvaluationForm::AutoEvaluationConfigurationProperty.new(**auto_evaluation_configuration.transform_keys(&:to_sym)) : auto_evaluation_configuration
  Jsii::Type.check_type(@auto_evaluation_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0LkNmbkV2YWx1YXRpb25Gb3JtLkF1dG9FdmFsdWF0aW9uQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "autoEvaluationConfiguration") unless @auto_evaluation_configuration.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @language_configuration = language_configuration.is_a?(Hash) ? ::AWSCDK::Connect::CfnEvaluationForm::EvaluationFormLanguageConfigurationProperty.new(**language_configuration.transform_keys(&:to_sym)) : language_configuration
  Jsii::Type.check_type(@language_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0LkNmbkV2YWx1YXRpb25Gb3JtLkV2YWx1YXRpb25Gb3JtTGFuZ3VhZ2VDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "languageConfiguration") unless @language_configuration.nil?
  @review_configuration = review_configuration.is_a?(Hash) ? ::AWSCDK::Connect::CfnEvaluationForm::EvaluationReviewConfigurationProperty.new(**review_configuration.transform_keys(&:to_sym)) : review_configuration
  Jsii::Type.check_type(@review_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0LkNmbkV2YWx1YXRpb25Gb3JtLkV2YWx1YXRpb25SZXZpZXdDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "reviewConfiguration") unless @review_configuration.nil?
  @scoring_strategy = scoring_strategy.is_a?(Hash) ? ::AWSCDK::Connect::CfnEvaluationForm::ScoringStrategyProperty.new(**scoring_strategy.transform_keys(&:to_sym)) : scoring_strategy
  Jsii::Type.check_type(@scoring_strategy, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0LkNmbkV2YWx1YXRpb25Gb3JtLlNjb3JpbmdTdHJhdGVneVByb3BlcnR5In1dfX0=")), "scoringStrategy") unless @scoring_strategy.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @target_configuration = target_configuration.is_a?(Hash) ? ::AWSCDK::Connect::CfnEvaluationForm::EvaluationFormTargetConfigurationProperty.new(**target_configuration.transform_keys(&:to_sym)) : target_configuration
  Jsii::Type.check_type(@target_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0LkNmbkV2YWx1YXRpb25Gb3JtLkV2YWx1YXRpb25Gb3JtVGFyZ2V0Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "targetConfiguration") unless @target_configuration.nil?
end

Instance Attribute Details

#auto_evaluation_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The automatic evaluation configuration of an evaluation form.

Returns:

See Also:



78
79
80
 
# File 'connect/cfn_evaluation_form_props.rb', line 78

def auto_evaluation_configuration
  @auto_evaluation_configuration
end

#description ⇒ String? (readonly)

The description of the evaluation form.

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

Returns:

  • (String, nil)

See Also:



85
86
87
 
# File 'connect/cfn_evaluation_form_props.rb', line 85

def description
  @description
end

#instance_arn ⇒ String, AWSCDK::Interfaces::AWSConnect::IInstanceRef (readonly)

The identifier of the Amazon Connect instance.

Returns:

See Also:



49
50
51
 
# File 'connect/cfn_evaluation_form_props.rb', line 49

def instance_arn
  @instance_arn
end

#items ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Connect::CfnEvaluationForm::EvaluationFormBaseItemProperty> (readonly)

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

Returns:

See Also:



60
61
62
 
# File 'connect/cfn_evaluation_form_props.rb', line 60

def items
  @items
end

#language_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Configuration for language settings of this evaluation form.

Returns:

See Also:



90
91
92
 
# File 'connect/cfn_evaluation_form_props.rb', line 90

def language_configuration
  @language_configuration
end

#review_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Configuration settings for evaluation reviews.

Returns:

See Also:



95
96
97
 
# File 'connect/cfn_evaluation_form_props.rb', line 95

def review_configuration
  @review_configuration
end

#scoring_strategy ⇒ AWSCDK::IResolvable, ... (readonly)

A scoring strategy of the evaluation form.

Returns:

See Also:



100
101
102
 
# File 'connect/cfn_evaluation_form_props.rb', line 100

def scoring_strategy
  @scoring_strategy
end

#status ⇒ String (readonly)

Note:

Default: - "DRAFT"

The status of the evaluation form.

Allowed values : DRAFT | ACTIVE

Returns:

  • (String)

See Also:



68
69
70
 
# File 'connect/cfn_evaluation_form_props.rb', line 68

def status
  @status
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

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

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

Returns:

See Also:



107
108
109
 
# File 'connect/cfn_evaluation_form_props.rb', line 107

def tags
  @tags
end

#target_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Configuration that specifies the target for this evaluation form.

Returns:

See Also:



112
113
114
 
# File 'connect/cfn_evaluation_form_props.rb', line 112

def target_configuration
  @target_configuration
end

#title ⇒ String (readonly)

A title of the evaluation form.

Returns:

  • (String)

See Also:



73
74
75
 
# File 'connect/cfn_evaluation_form_props.rb', line 73

def title
  @title
end

Class Method Details

.jsii_properties ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'connect/cfn_evaluation_form_props.rb', line 114

def self.jsii_properties
  {
    :instance_arn => "instanceArn",
    :items => "items",
    :status => "status",
    :title => "title",
    :auto_evaluation_configuration => "autoEvaluationConfiguration",
    :description => "description",
    :language_configuration => "languageConfiguration",
    :review_configuration => "reviewConfiguration",
    :scoring_strategy => "scoringStrategy",
    :tags => "tags",
    :target_configuration => "targetConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'connect/cfn_evaluation_form_props.rb', line 130

def to_jsii
  result = {}
  result.merge!({
    "instanceArn" => @instance_arn,
    "items" => @items,
    "status" => @status,
    "title" => @title,
    "autoEvaluationConfiguration" => @auto_evaluation_configuration,
    "description" => @description,
    "languageConfiguration" => @language_configuration,
    "reviewConfiguration" => @review_configuration,
    "scoringStrategy" => @scoring_strategy,
    "tags" => @tags,
    "targetConfiguration" => @target_configuration,
  })
  result.compact
end