Class: AWSCDK::Lex::CfnBot

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSLex::IBotRef
Defined in:
lex/cfn_bot.rb

Overview

Amazon Lex V2 is the only supported version in CloudFormation .

Specifies an Amazon Lex conversational bot.

You must configure an intent based on the AMAZON.FallbackIntent built-in intent. If you don't add one, creating the bot will fail.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnBot

Create a new AWS::Lex::Bot.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::Lex::CfnBotProps) —

    Resource properties.



22
23
24
25
26
27
28
 
# File 'lex/cfn_bot.rb', line 22

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Lex::CfnBotProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGV4LkNmbkJvdFByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_bot(resource) ⇒ String

Parameters:

Returns:

  • (String) 


89
90
91
92
 
# File 'lex/cfn_bot.rb', line 89

def self.arn_for_bot(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19sZXguSUJvdFJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_lex.CfnBot", "arnForBot", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


196
197
198
 
# File 'lex/cfn_bot.rb', line 196

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

.is_cfn_bot(x) ⇒ Boolean

Checks whether the given object is a CfnBot.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


98
99
100
101
 
# File 'lex/cfn_bot.rb', line 98

def self.is_cfn_bot(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_lex.CfnBot", "isCfnBot", [x])
end

.jsii_overridable_methods ⇒ Object 



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
79
80
81
82
83
84
85
 
# File 'lex/cfn_bot.rb', line 30

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_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :bot_ref => { kind: :property, name: "botRef", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :data_privacy => { kind: :property, name: "dataPrivacy", is_optional: false },
    :idle_session_ttl_in_seconds => { kind: :property, name: "idleSessionTtlInSeconds", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :role_arn => { kind: :property, name: "roleArn", is_optional: false },
    :auto_build_bot_locales => { kind: :property, name: "autoBuildBotLocales", is_optional: true },
    :bot_file_s3_location => { kind: :property, name: "botFileS3Location", is_optional: true },
    :bot_locales => { kind: :property, name: "botLocales", is_optional: true },
    :bot_tags => { kind: :property, name: "botTags", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :error_log_settings => { kind: :property, name: "errorLogSettings", is_optional: true },
    :replication => { kind: :property, name: "replication", is_optional: true },
    :test_bot_alias_settings => { kind: :property, name: "testBotAliasSettings", is_optional: true },
    :test_bot_alias_tags => { kind: :property, name: "testBotAliasTags", 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.



421
422
423
424
 
# File 'lex/cfn_bot.rb', line 421

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:



433
434
435
436
 
# File 'lex/cfn_bot.rb', line 433

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:



443
444
445
446
 
# File 'lex/cfn_bot.rb', line 443

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:



454
455
456
457
458
 
# File 'lex/cfn_bot.rb', line 454

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.


511
512
513
514
515
 
# File 'lex/cfn_bot.rb', line 511

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.



521
522
523
524
 
# File 'lex/cfn_bot.rb', line 521

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.



533
534
535
536
537
 
# File 'lex/cfn_bot.rb', line 533

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:



546
547
548
549
 
# File 'lex/cfn_bot.rb', line 546

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:



568
569
570
571
572
573
 
# File 'lex/cfn_bot.rb', line 568

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_arn ⇒ String

The Amazon Resource Name (ARN) of the bot.

Returns:

  • (String) 


203
204
205
 
# File 'lex/cfn_bot.rb', line 203

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_id ⇒ String

The unique identifier of the bot.

Returns:

  • (String) 


210
211
212
 
# File 'lex/cfn_bot.rb', line 210

def attr_id()
  jsii_get_property("attrId")
end

#auto_build_bot_locales ⇒ Boolean, ...

Indicates whether Amazon Lex V2 should automatically build the locales for the bot after a change.

Returns:



279
280
281
 
# File 'lex/cfn_bot.rb', line 279

def auto_build_bot_locales()
  jsii_get_property("autoBuildBotLocales")
end

#auto_build_bot_locales=(value) ⇒ Object 



283
284
285
286
 
# File 'lex/cfn_bot.rb', line 283

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

#bot_file_s3_location ⇒ AWSCDK::IResolvable, ...

The Amazon S3 location of files used to import a bot.

Returns:



291
292
293
 
# File 'lex/cfn_bot.rb', line 291

def bot_file_s3_location()
  jsii_get_property("botFileS3Location")
end

#bot_file_s3_location=(value) ⇒ Object 



295
296
297
298
299
 
# File 'lex/cfn_bot.rb', line 295

def bot_file_s3_location=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lex::CfnBot::S3LocationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sZXguQ2ZuQm90LlMzTG9jYXRpb25Qcm9wZXJ0eSJ9XX19")), "botFileS3Location") unless value.nil?
  jsii_set_property("botFileS3Location", value)
end

#bot_locales ⇒ AWSCDK::IResolvable, ...

A list of locales for the bot.

Returns:



304
305
306
 
# File 'lex/cfn_bot.rb', line 304

def bot_locales()
  jsii_get_property("botLocales")
end

#bot_locales=(value) ⇒ Object 



308
309
310
311
 
# File 'lex/cfn_bot.rb', line 308

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

#bot_ref ⇒ AWSCDK::Interfaces::AWSLex::BotReference

A reference to a Bot resource.

Returns:



217
218
219
 
# File 'lex/cfn_bot.rb', line 217

def bot_ref()
  jsii_get_property("botRef")
end

#bot_tags ⇒ Array<AWSCDK::CfnTag>?

A list of tags to add to the bot.

Returns:



316
317
318
 
# File 'lex/cfn_bot.rb', line 316

def bot_tags()
  jsii_get_property("botTags")
end

#bot_tags=(value) ⇒ Object 



320
321
322
323
324
 
# File 'lex/cfn_bot.rb', line 320

def bot_tags=(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=")), "botTags") unless value.nil?
  jsii_set_property("botTags", value)
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



224
225
226
 
# File 'lex/cfn_bot.rb', line 224

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



149
150
151
 
# File 'lex/cfn_bot.rb', line 149

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


154
155
156
 
# File 'lex/cfn_bot.rb', line 154

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


577
578
579
580
 
# File 'lex/cfn_bot.rb', line 577

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}) 


159
160
161
 
# File 'lex/cfn_bot.rb', line 159

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


166
167
168
 
# File 'lex/cfn_bot.rb', line 166

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


111
112
113
 
# File 'lex/cfn_bot.rb', line 111

def creation_stack()
  jsii_get_property("creationStack")
end

#data_privacy ⇒ Object

By default, data stored by Amazon Lex is encrypted.

Returns:

  • (Object) 


231
232
233
 
# File 'lex/cfn_bot.rb', line 231

def data_privacy()
  jsii_get_property("dataPrivacy")
end

#data_privacy=(value) ⇒ Object 



235
236
237
238
 
# File 'lex/cfn_bot.rb', line 235

def data_privacy=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "dataPrivacy")
  jsii_set_property("dataPrivacy", value)
end

#description ⇒ String?

The description of the version.

Returns:

  • (String, nil) 


329
330
331
 
# File 'lex/cfn_bot.rb', line 329

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



333
334
335
336
 
# File 'lex/cfn_bot.rb', line 333

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:



171
172
173
 
# File 'lex/cfn_bot.rb', line 171

def env()
  jsii_get_property("env")
end

#error_log_settings ⇒ AWSCDK::IResolvable, ...

Returns:



339
340
341
 
# File 'lex/cfn_bot.rb', line 339

def error_log_settings()
  jsii_get_property("errorLogSettings")
end

#error_log_settings=(value) ⇒ Object 



343
344
345
346
347
 
# File 'lex/cfn_bot.rb', line 343

def error_log_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lex::CfnBot::ErrorLogSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sZXguQ2ZuQm90LkVycm9yTG9nU2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "errorLogSettings") unless value.nil?
  jsii_set_property("errorLogSettings", value)
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:



590
591
592
593
594
 
# File 'lex/cfn_bot.rb', line 590

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:



601
602
603
604
 
# File 'lex/cfn_bot.rb', line 601

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

#idle_session_ttl_in_seconds ⇒ Numeric

The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

Returns:

  • (Numeric) 


243
244
245
 
# File 'lex/cfn_bot.rb', line 243

def idle_session_ttl_in_seconds()
  jsii_get_property("idleSessionTtlInSeconds")
end

#idle_session_ttl_in_seconds=(value) ⇒ Object 



247
248
249
250
 
# File 'lex/cfn_bot.rb', line 247

def idle_session_ttl_in_seconds=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "idleSessionTtlInSeconds")
  jsii_set_property("idleSessionTtlInSeconds", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



671
672
673
674
 
# File 'lex/cfn_bot.rb', line 671

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


123
124
125
 
# File 'lex/cfn_bot.rb', line 123

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The name of the bot locale.

Returns:

  • (String) 


255
256
257
 
# File 'lex/cfn_bot.rb', line 255

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



259
260
261
262
 
# File 'lex/cfn_bot.rb', line 259

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


106
107
108
 
# File 'lex/cfn_bot.rb', line 106

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:



612
613
614
 
# File 'lex/cfn_bot.rb', line 612

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:



619
620
621
 
# File 'lex/cfn_bot.rb', line 619

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.



412
413
414
415
 
# File 'lex/cfn_bot.rb', line 412

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) 


142
143
144
 
# File 'lex/cfn_bot.rb', line 142

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:



630
631
632
633
 
# File 'lex/cfn_bot.rb', line 630

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}) 


637
638
639
640
 
# File 'lex/cfn_bot.rb', line 637

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:



647
648
649
650
651
 
# File 'lex/cfn_bot.rb', line 647

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

#replication ⇒ AWSCDK::IResolvable, ...

Returns:



350
351
352
 
# File 'lex/cfn_bot.rb', line 350

def replication()
  jsii_get_property("replication")
end

#replication=(value) ⇒ Object 



354
355
356
357
358
 
# File 'lex/cfn_bot.rb', line 354

def replication=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lex::CfnBot::ReplicationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sZXguQ2ZuQm90LlJlcGxpY2F0aW9uUHJvcGVydHkifV19fQ==")), "replication") unless value.nil?
  jsii_set_property("replication", value)
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.

Returns:

  • (String) 


267
268
269
 
# File 'lex/cfn_bot.rb', line 267

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object 



271
272
273
274
 
# File 'lex/cfn_bot.rb', line 271

def role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  jsii_set_property("roleArn", 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.



656
657
658
 
# File 'lex/cfn_bot.rb', line 656

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:



132
133
134
 
# File 'lex/cfn_bot.rb', line 132

def stack()
  jsii_get_property("stack")
end

#test_bot_alias_settings ⇒ AWSCDK::IResolvable, ...

Specifies configuration settings for the alias used to test the bot.

Returns:



363
364
365
 
# File 'lex/cfn_bot.rb', line 363

def test_bot_alias_settings()
  jsii_get_property("testBotAliasSettings")
end

#test_bot_alias_settings=(value) ⇒ Object 



367
368
369
370
371
 
# File 'lex/cfn_bot.rb', line 367

def test_bot_alias_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lex::CfnBot::TestBotAliasSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sZXguQ2ZuQm90LlRlc3RCb3RBbGlhc1NldHRpbmdzUHJvcGVydHkifV19fQ==")), "testBotAliasSettings") unless value.nil?
  jsii_set_property("testBotAliasSettings", value)
end

#test_bot_alias_tags ⇒ AWSCDK::IResolvable, ...

A list of tags to add to the test alias for a bot.

Returns:



376
377
378
 
# File 'lex/cfn_bot.rb', line 376

def test_bot_alias_tags()
  jsii_get_property("testBotAliasTags")
end

#test_bot_alias_tags=(value) ⇒ Object 



380
381
382
383
 
# File 'lex/cfn_bot.rb', line 380

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



388
389
390
 
# File 'lex/cfn_bot.rb', line 388

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}) 


179
180
181
 
# File 'lex/cfn_bot.rb', line 179

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}) 


189
190
191
 
# File 'lex/cfn_bot.rb', line 189

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


662
663
664
665
 
# File 'lex/cfn_bot.rb', line 662

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) 


401
402
403
404
405
406
 
# File 'lex/cfn_bot.rb', line 401

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