Class: AWSCDK::Lex::CfnBot::FulfillmentUpdatesSpecificationProperty

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

Overview

Provides information for updating the user on the progress of fulfilling an intent.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(active:, start_response: nil, timeout_in_seconds: nil, update_response: nil) ⇒ FulfillmentUpdatesSpecificationProperty

Returns a new instance of FulfillmentUpdatesSpecificationProperty.

Parameters:



2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
 
# File 'lex/cfn_bot.rb', line 2859

def initialize(active:, start_response: nil, timeout_in_seconds: nil, update_response: nil)
  @active = active
  Jsii::Type.check_type(@active, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "active")
  @start_response = start_response.is_a?(Hash) ? ::AWSCDK::Lex::CfnBot::FulfillmentStartResponseSpecificationProperty.new(**start_response.transform_keys(&:to_sym)) : start_response
  Jsii::Type.check_type(@start_response, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sZXguQ2ZuQm90LkZ1bGZpbGxtZW50U3RhcnRSZXNwb25zZVNwZWNpZmljYXRpb25Qcm9wZXJ0eSJ9XX19")), "startResponse") unless @start_response.nil?
  @timeout_in_seconds = timeout_in_seconds
  Jsii::Type.check_type(@timeout_in_seconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "timeoutInSeconds") unless @timeout_in_seconds.nil?
  @update_response = update_response.is_a?(Hash) ? ::AWSCDK::Lex::CfnBot::FulfillmentUpdateResponseSpecificationProperty.new(**update_response.transform_keys(&:to_sym)) : update_response
  Jsii::Type.check_type(@update_response, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sZXguQ2ZuQm90LkZ1bGZpbGxtZW50VXBkYXRlUmVzcG9uc2VTcGVjaWZpY2F0aW9uUHJvcGVydHkifV19fQ==")), "updateResponse") unless @update_response.nil?
end

Instance Attribute Details

#active ⇒ Boolean, AWSCDK::IResolvable (readonly)

Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.

If the active field is set to true, the start_response , update_response , and timeout_in_seconds fields are required.

Returns:

See Also:



2876
2877
2878
 
# File 'lex/cfn_bot.rb', line 2876

def active
  @active
end

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

Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.

Returns:

See Also:



2881
2882
2883
 
# File 'lex/cfn_bot.rb', line 2881

def start_response
  @start_response
end

#timeout_in_seconds ⇒ Numeric? (readonly)

The length of time that the fulfillment Lambda function should run before it times out.

Returns:

  • (Numeric, nil)

See Also:



2886
2887
2888
 
# File 'lex/cfn_bot.rb', line 2886

def timeout_in_seconds
  @timeout_in_seconds
end

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

Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.

Returns:

See Also:



2891
2892
2893
 
# File 'lex/cfn_bot.rb', line 2891

def update_response
  @update_response
end

Class Method Details

.jsii_properties ⇒ Object 



2893
2894
2895
2896
2897
2898
2899
2900
 
# File 'lex/cfn_bot.rb', line 2893

def self.jsii_properties
  {
    :active => "active",
    :start_response => "startResponse",
    :timeout_in_seconds => "timeoutInSeconds",
    :update_response => "updateResponse",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
 
# File 'lex/cfn_bot.rb', line 2902

def to_jsii
  result = {}
  result.merge!({
    "active" => @active,
    "startResponse" => @start_response,
    "timeoutInSeconds" => @timeout_in_seconds,
    "updateResponse" => @update_response,
  })
  result.compact
end