Class: AWSCDK::Connect::CfnEvaluationForm

Inherits:
AWSCDK::CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSConnect::IEvaluationFormRef
Defined in:
connect/cfn_evaluation_form.rb

Overview

Creates an evaluation form for the specified Connect Customer instance.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnEvaluationForm

Create a new AWS::Connect::EvaluationForm.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::Connect::CfnEvaluationFormProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'connect/cfn_evaluation_form.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Connect::CfnEvaluationFormProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29ubmVjdC5DZm5FdmFsdWF0aW9uRm9ybVByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_evaluation_form(resource) ⇒ String

Parameters:

Returns:

  • (String) 


82
83
84
85
 
# File 'connect/cfn_evaluation_form.rb', line 82

def self.arn_for_evaluation_form(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jb25uZWN0LklFdmFsdWF0aW9uRm9ybVJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_connect.CfnEvaluationForm", "arnForEvaluationForm", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


189
190
191
 
# File 'connect/cfn_evaluation_form.rb', line 189

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_connect.CfnEvaluationForm", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_evaluation_form(x) ⇒ Boolean

Checks whether the given object is a CfnEvaluationForm.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


91
92
93
94
 
# File 'connect/cfn_evaluation_form.rb', line 91

def self.is_cfn_evaluation_form(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_connect.CfnEvaluationForm", "isCfnEvaluationForm", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'connect/cfn_evaluation_form.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_evaluation_form_arn => { kind: :property, name: "attrEvaluationFormArn", is_optional: false },
    :evaluation_form_ref => { kind: :property, name: "evaluationFormRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :instance_arn => { kind: :property, name: "instanceArn", is_optional: false },
    :items => { kind: :property, name: "items", is_optional: false },
    :status => { kind: :property, name: "status", is_optional: false },
    :title => { kind: :property, name: "title", is_optional: false },
    :auto_evaluation_configuration => { kind: :property, name: "autoEvaluationConfiguration", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :language_configuration => { kind: :property, name: "languageConfiguration", is_optional: true },
    :review_configuration => { kind: :property, name: "reviewConfiguration", is_optional: true },
    :scoring_strategy => { kind: :property, name: "scoringStrategy", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :target_configuration => { kind: :property, name: "targetConfiguration", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



388
389
390
391
 
# File 'connect/cfn_evaluation_form.rb', line 388

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

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

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

Parameters:



400
401
402
403
 
# File 'connect/cfn_evaluation_form.rb', line 400

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

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

Parameters:



410
411
412
413
 
# File 'connect/cfn_evaluation_form.rb', line 410

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



421
422
423
424
425
 
# File 'connect/cfn_evaluation_form.rb', line 421

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

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

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

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

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

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

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


478
479
480
481
482
 
# File 'connect/cfn_evaluation_form.rb', line 478

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

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

Parameters:

  • property_path (String) —

    The path to the property.



488
489
490
491
 
# File 'connect/cfn_evaluation_form.rb', line 488

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

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

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



500
501
502
503
504
 
# File 'connect/cfn_evaluation_form.rb', line 500

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



513
514
515
516
 
# File 'connect/cfn_evaluation_form.rb', line 513

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

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

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

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



535
536
537
538
539
540
 
# File 'connect/cfn_evaluation_form.rb', line 535

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_evaluation_form_arn ⇒ String

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

Returns:

  • (String) 


196
197
198
 
# File 'connect/cfn_evaluation_form.rb', line 196

def attr_evaluation_form_arn()
  jsii_get_property("attrEvaluationFormArn")
end

#auto_evaluation_configuration ⇒ AWSCDK::IResolvable, ...

The automatic evaluation configuration of an evaluation form.

Returns:



265
266
267
 
# File 'connect/cfn_evaluation_form.rb', line 265

def auto_evaluation_configuration()
  jsii_get_property("autoEvaluationConfiguration")
end

#auto_evaluation_configuration=(value) ⇒ Object 



269
270
271
272
273
 
# File 'connect/cfn_evaluation_form.rb', line 269

def auto_evaluation_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Connect::CfnEvaluationForm::AutoEvaluationConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0LkNmbkV2YWx1YXRpb25Gb3JtLkF1dG9FdmFsdWF0aW9uQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "autoEvaluationConfiguration") unless value.nil?
  jsii_set_property("autoEvaluationConfiguration", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



142
143
144
 
# File 'connect/cfn_evaluation_form.rb', line 142

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


147
148
149
 
# File 'connect/cfn_evaluation_form.rb', line 147

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


544
545
546
547
 
# File 'connect/cfn_evaluation_form.rb', line 544

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


152
153
154
 
# File 'connect/cfn_evaluation_form.rb', line 152

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


159
160
161
 
# File 'connect/cfn_evaluation_form.rb', line 159

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


104
105
106
 
# File 'connect/cfn_evaluation_form.rb', line 104

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The description of the evaluation form.

Returns:

  • (String, nil) 


278
279
280
 
# File 'connect/cfn_evaluation_form.rb', line 278

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



282
283
284
285
 
# File 'connect/cfn_evaluation_form.rb', line 282

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



164
165
166
 
# File 'connect/cfn_evaluation_form.rb', line 164

def env()
  jsii_get_property("env")
end

#evaluation_form_ref ⇒ AWSCDK::Interfaces::AWSConnect::EvaluationFormReference

A reference to a EvaluationForm resource.

Returns:



203
204
205
 
# File 'connect/cfn_evaluation_form.rb', line 203

def evaluation_form_ref()
  jsii_get_property("evaluationFormRef")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

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

Parameters:

Returns:



557
558
559
560
561
 
# File 'connect/cfn_evaluation_form.rb', line 557

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



568
569
570
571
 
# File 'connect/cfn_evaluation_form.rb', line 568

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



638
639
640
641
 
# File 'connect/cfn_evaluation_form.rb', line 638

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#instance_arn ⇒ String

The identifier of the Amazon Connect instance.

Returns:

  • (String) 


217
218
219
 
# File 'connect/cfn_evaluation_form.rb', line 217

def instance_arn()
  jsii_get_property("instanceArn")
end

#instance_arn=(value) ⇒ Object 



221
222
223
224
 
# File 'connect/cfn_evaluation_form.rb', line 221

def instance_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceArn")
  jsii_set_property("instanceArn", value)
end

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

Items that are part of the evaluation form.

Returns:



229
230
231
 
# File 'connect/cfn_evaluation_form.rb', line 229

def items()
  jsii_get_property("items")
end

#items=(value) ⇒ Object 



233
234
235
236
 
# File 'connect/cfn_evaluation_form.rb', line 233

def items=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29ubmVjdC5DZm5FdmFsdWF0aW9uRm9ybS5FdmFsdWF0aW9uRm9ybUJhc2VJdGVtUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "items")
  jsii_set_property("items", value)
end

#language_configuration ⇒ AWSCDK::IResolvable, ...

Configuration for language settings of this evaluation form.

Returns:



290
291
292
 
# File 'connect/cfn_evaluation_form.rb', line 290

def language_configuration()
  jsii_get_property("languageConfiguration")
end

#language_configuration=(value) ⇒ Object 



294
295
296
297
298
 
# File 'connect/cfn_evaluation_form.rb', line 294

def language_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Connect::CfnEvaluationForm::EvaluationFormLanguageConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0LkNmbkV2YWx1YXRpb25Gb3JtLkV2YWx1YXRpb25Gb3JtTGFuZ3VhZ2VDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "languageConfiguration") unless value.nil?
  jsii_set_property("languageConfiguration", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

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

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


116
117
118
 
# File 'connect/cfn_evaluation_form.rb', line 116

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


99
100
101
 
# File 'connect/cfn_evaluation_form.rb', line 99

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



579
580
581
 
# File 'connect/cfn_evaluation_form.rb', line 579

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



586
587
588
 
# File 'connect/cfn_evaluation_form.rb', line 586

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

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

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



379
380
381
382
 
# File 'connect/cfn_evaluation_form.rb', line 379

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

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

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

Returns:

  • (String) 


135
136
137
 
# File 'connect/cfn_evaluation_form.rb', line 135

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



597
598
599
600
 
# File 'connect/cfn_evaluation_form.rb', line 597

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


604
605
606
607
 
# File 'connect/cfn_evaluation_form.rb', line 604

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



614
615
616
617
618
 
# File 'connect/cfn_evaluation_form.rb', line 614

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#review_configuration ⇒ AWSCDK::IResolvable, ...

Configuration settings for evaluation reviews.

Returns:



303
304
305
 
# File 'connect/cfn_evaluation_form.rb', line 303

def review_configuration()
  jsii_get_property("reviewConfiguration")
end

#review_configuration=(value) ⇒ Object 



307
308
309
310
311
 
# File 'connect/cfn_evaluation_form.rb', line 307

def review_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Connect::CfnEvaluationForm::EvaluationReviewConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0LkNmbkV2YWx1YXRpb25Gb3JtLkV2YWx1YXRpb25SZXZpZXdDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "reviewConfiguration") unless value.nil?
  jsii_set_property("reviewConfiguration", value)
end

#scoring_strategy ⇒ AWSCDK::IResolvable, ...

A scoring strategy of the evaluation form.

Returns:



316
317
318
 
# File 'connect/cfn_evaluation_form.rb', line 316

def scoring_strategy()
  jsii_get_property("scoringStrategy")
end

#scoring_strategy=(value) ⇒ Object 



320
321
322
323
324
 
# File 'connect/cfn_evaluation_form.rb', line 320

def scoring_strategy=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Connect::CfnEvaluationForm::ScoringStrategyProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0LkNmbkV2YWx1YXRpb25Gb3JtLlNjb3JpbmdTdHJhdGVneVByb3BlcnR5In1dfX0=")), "scoringStrategy") unless value.nil?
  jsii_set_property("scoringStrategy", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



623
624
625
 
# File 'connect/cfn_evaluation_form.rb', line 623

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



125
126
127
 
# File 'connect/cfn_evaluation_form.rb', line 125

def stack()
  jsii_get_property("stack")
end

#status ⇒ String

The status of the evaluation form.

Returns:

  • (String) 


241
242
243
 
# File 'connect/cfn_evaluation_form.rb', line 241

def status()
  jsii_get_property("status")
end

#status=(value) ⇒ Object 



245
246
247
248
 
# File 'connect/cfn_evaluation_form.rb', line 245

def status=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status")
  jsii_set_property("status", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



210
211
212
 
# File 'connect/cfn_evaluation_form.rb', line 210

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



329
330
331
 
# File 'connect/cfn_evaluation_form.rb', line 329

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



333
334
335
336
337
 
# File 'connect/cfn_evaluation_form.rb', line 333

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#target_configuration ⇒ AWSCDK::IResolvable, ...

Configuration that specifies the target for this evaluation form.

Returns:



342
343
344
 
# File 'connect/cfn_evaluation_form.rb', line 342

def target_configuration()
  jsii_get_property("targetConfiguration")
end

#target_configuration=(value) ⇒ Object 



346
347
348
349
350
 
# File 'connect/cfn_evaluation_form.rb', line 346

def target_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Connect::CfnEvaluationForm::EvaluationFormTargetConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0LkNmbkV2YWx1YXRpb25Gb3JtLkV2YWx1YXRpb25Gb3JtVGFyZ2V0Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "targetConfiguration") unless value.nil?
  jsii_set_property("targetConfiguration", value)
end

#title ⇒ String

A title of the evaluation form.

Returns:

  • (String) 


253
254
255
 
# File 'connect/cfn_evaluation_form.rb', line 253

def title()
  jsii_get_property("title")
end

#title=(value) ⇒ Object 



257
258
259
260
 
# File 'connect/cfn_evaluation_form.rb', line 257

def title=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "title")
  jsii_set_property("title", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



355
356
357
 
# File 'connect/cfn_evaluation_form.rb', line 355

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


172
173
174
 
# File 'connect/cfn_evaluation_form.rb', line 172

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


182
183
184
 
# File 'connect/cfn_evaluation_form.rb', line 182

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


629
630
631
632
 
# File 'connect/cfn_evaluation_form.rb', line 629

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


368
369
370
371
372
373
 
# File 'connect/cfn_evaluation_form.rb', line 368

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end