Class: AWSCDK::Lex::CfnBot::PromptSpecificationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
lex/cfn_bot.rb

Overview

Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(max_retries:, message_groups_list:, allow_interrupt: nil, message_selection_strategy: nil, prompt_attempts_specification: nil) ⇒ PromptSpecificationProperty

Returns a new instance of PromptSpecificationProperty.

Parameters:



4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
 
# File 'lex/cfn_bot.rb', line 4561

def initialize(max_retries:, message_groups_list:, allow_interrupt: nil, message_selection_strategy: nil, prompt_attempts_specification: nil)
  @max_retries = max_retries
  Jsii::Type.check_type(@max_retries, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxRetries")
  @message_groups_list = message_groups_list
  Jsii::Type.check_type(@message_groups_list, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGV4LkNmbkJvdC5NZXNzYWdlR3JvdXBQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "messageGroupsList")
  @allow_interrupt = allow_interrupt
  Jsii::Type.check_type(@allow_interrupt, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "allowInterrupt") unless @allow_interrupt.nil?
  @message_selection_strategy = message_selection_strategy
  Jsii::Type.check_type(@message_selection_strategy, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "messageSelectionStrategy") unless @message_selection_strategy.nil?
  @prompt_attempts_specification = prompt_attempts_specification
  Jsii::Type.check_type(@prompt_attempts_specification, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGV4LkNmbkJvdC5Qcm9tcHRBdHRlbXB0U3BlY2lmaWNhdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJtYXAifX1dfX0=")), "promptAttemptsSpecification") unless @prompt_attempts_specification.nil?
end

Instance Attribute Details

#allow_interrupt ⇒ Boolean, ... (readonly)

Indicates whether the user can interrupt a speech prompt from the bot.

Returns:

See Also:



4590
4591
4592
 
# File 'lex/cfn_bot.rb', line 4590

def allow_interrupt
  @allow_interrupt
end

#max_retries ⇒ Numeric (readonly)

The maximum number of times the bot tries to elicit a response from the user using this prompt.

Returns:

  • (Numeric)

See Also:



4578
4579
4580
 
# File 'lex/cfn_bot.rb', line 4578

def max_retries
  @max_retries
end

#message_groups_list ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Lex::CfnBot::MessageGroupProperty> (readonly)

A collection of messages that Amazon Lex can send to the user.

Amazon Lex chooses the actual message to send at runtime.

Returns:

See Also:



4585
4586
4587
 
# File 'lex/cfn_bot.rb', line 4585

def message_groups_list
  @message_groups_list
end

#message_selection_strategy ⇒ String? (readonly)

Indicates how a message is selected from a message group among retries.

Returns:

  • (String, nil)

See Also:



4595
4596
4597
 
# File 'lex/cfn_bot.rb', line 4595

def message_selection_strategy
  @message_selection_strategy
end

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

Specifies the advanced settings on each attempt of the prompt.

Returns:

See Also:



4600
4601
4602
 
# File 'lex/cfn_bot.rb', line 4600

def prompt_attempts_specification
  @prompt_attempts_specification
end

Class Method Details

.jsii_properties ⇒ Object 



4602
4603
4604
4605
4606
4607
4608
4609
4610
 
# File 'lex/cfn_bot.rb', line 4602

def self.jsii_properties
  {
    :max_retries => "maxRetries",
    :message_groups_list => "messageGroupsList",
    :allow_interrupt => "allowInterrupt",
    :message_selection_strategy => "messageSelectionStrategy",
    :prompt_attempts_specification => "promptAttemptsSpecification",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
 
# File 'lex/cfn_bot.rb', line 4612

def to_jsii
  result = {}
  result.merge!({
    "maxRetries" => @max_retries,
    "messageGroupsList" => @message_groups_list,
    "allowInterrupt" => @allow_interrupt,
    "messageSelectionStrategy" => @message_selection_strategy,
    "promptAttemptsSpecification" => @prompt_attempts_specification,
  })
  result.compact
end