Class: AWSCDK::Lex::CfnBot::FulfillmentUpdateResponseSpecificationProperty

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

Overview

Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(frequency_in_seconds:, message_groups:, allow_interrupt: nil) ⇒ FulfillmentUpdateResponseSpecificationProperty

Returns a new instance of FulfillmentUpdateResponseSpecificationProperty.

Parameters:



2801
2802
2803
2804
2805
2806
2807
2808
 
# File 'lex/cfn_bot.rb', line 2801

def initialize(frequency_in_seconds:, message_groups:, allow_interrupt: nil)
  @frequency_in_seconds = frequency_in_seconds
  Jsii::Type.check_type(@frequency_in_seconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "frequencyInSeconds")
  @message_groups = message_groups
  Jsii::Type.check_type(@message_groups, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGV4LkNmbkJvdC5NZXNzYWdlR3JvdXBQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "messageGroups")
  @allow_interrupt = allow_interrupt
  Jsii::Type.check_type(@allow_interrupt, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "allowInterrupt") unless @allow_interrupt.nil?
end

Instance Attribute Details

#allow_interrupt ⇒ Boolean, ... (readonly)

Determines whether the user can interrupt an update message while it is playing.

Returns:

See Also:



2828
2829
2830
 
# File 'lex/cfn_bot.rb', line 2828

def allow_interrupt
  @allow_interrupt
end

#frequency_in_seconds ⇒ Numeric (readonly)

The frequency that a message is sent to the user.

When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.

Returns:

  • (Numeric)

See Also:



2816
2817
2818
 
# File 'lex/cfn_bot.rb', line 2816

def frequency_in_seconds
  @frequency_in_seconds
end

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

1 - 5 message groups that contain update messages.

Amazon Lex chooses one of the messages to play to the user.

Returns:

See Also:



2823
2824
2825
 
# File 'lex/cfn_bot.rb', line 2823

def message_groups
  @message_groups
end

Class Method Details

.jsii_properties ⇒ Object 



2830
2831
2832
2833
2834
2835
2836
 
# File 'lex/cfn_bot.rb', line 2830

def self.jsii_properties
  {
    :frequency_in_seconds => "frequencyInSeconds",
    :message_groups => "messageGroups",
    :allow_interrupt => "allowInterrupt",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2838
2839
2840
2841
2842
2843
2844
2845
2846
 
# File 'lex/cfn_bot.rb', line 2838

def to_jsii
  result = {}
  result.merge!({
    "frequencyInSeconds" => @frequency_in_seconds,
    "messageGroups" => @message_groups,
    "allowInterrupt" => @allow_interrupt,
  })
  result.compact
end