Class: AWSCDK::Wisdom::CfnQuickResponseProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
wisdom/cfn_quick_response_props.rb

Overview

Properties for defining a CfnQuickResponse.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(content:, knowledge_base_arn:, name:, channels: nil, content_type: nil, description: nil, grouping_configuration: nil, is_active: nil, language: nil, shortcut_key: nil, tags: nil) ⇒ CfnQuickResponseProps

Returns a new instance of CfnQuickResponseProps.

Parameters:

  • content (AWSCDK::IResolvable, AWSCDK::Wisdom::CfnQuickResponse::QuickResponseContentProviderProperty) —

    The content of the quick response.

  • knowledge_base_arn (String) —

    The Amazon Resource Name (ARN) of the knowledge base.

  • name (String) —

    The name of the quick response.

  • channels (Array<String>, nil) (defaults to: nil) —

    The Amazon Connect contact channels this quick response applies to.

  • content_type (String, nil) (defaults to: nil) —

    The media type of the quick response content.

  • description (String, nil) (defaults to: nil) —

    The description of the quick response.

  • grouping_configuration (AWSCDK::IResolvable, AWSCDK::Wisdom::CfnQuickResponse::GroupingConfigurationProperty, nil) (defaults to: nil) —

    The configuration information of the user groups that the quick response is accessible to.

  • is_active (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Whether the quick response is active.

  • language (String, nil) (defaults to: nil) —

    The language code value for the language in which the quick response is written.

  • shortcut_key (String, nil) (defaults to: nil) —

    The shortcut key of the quick response.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

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



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'wisdom/cfn_quick_response_props.rb', line 20

def initialize(content:, knowledge_base_arn:, name:, channels: nil, content_type: nil, description: nil, grouping_configuration: nil, is_active: nil, language: nil, shortcut_key: nil, tags: nil)
  @content = content.is_a?(Hash) ? ::AWSCDK::Wisdom::CfnQuickResponse::QuickResponseContentProviderProperty.new(**content.transform_keys(&:to_sym)) : content
  Jsii::Type.check_type(@content, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193aXNkb20uQ2ZuUXVpY2tSZXNwb25zZS5RdWlja1Jlc3BvbnNlQ29udGVudFByb3ZpZGVyUHJvcGVydHkifV19fQ==")), "content")
  @knowledge_base_arn = knowledge_base_arn
  Jsii::Type.check_type(@knowledge_base_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "knowledgeBaseArn")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @channels = channels
  Jsii::Type.check_type(@channels, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "channels") unless @channels.nil?
  @content_type = content_type
  Jsii::Type.check_type(@content_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "contentType") unless @content_type.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @grouping_configuration = grouping_configuration.is_a?(Hash) ? ::AWSCDK::Wisdom::CfnQuickResponse::GroupingConfigurationProperty.new(**grouping_configuration.transform_keys(&:to_sym)) : grouping_configuration
  Jsii::Type.check_type(@grouping_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193aXNkb20uQ2ZuUXVpY2tSZXNwb25zZS5Hcm91cGluZ0NvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "groupingConfiguration") unless @grouping_configuration.nil?
  @is_active = is_active
  Jsii::Type.check_type(@is_active, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "isActive") unless @is_active.nil?
  @language = language
  Jsii::Type.check_type(@language, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "language") unless @language.nil?
  @shortcut_key = shortcut_key
  Jsii::Type.check_type(@shortcut_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "shortcutKey") unless @shortcut_key.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#channels ⇒ Array<String>? (readonly)

The Amazon Connect contact channels this quick response applies to.

The supported contact channel types include Chat .

Returns:

  • (Array<String>, nil)

See Also:



66
67
68
 
# File 'wisdom/cfn_quick_response_props.rb', line 66

def channels
  @channels
end

#content ⇒ AWSCDK::IResolvable, AWSCDK::Wisdom::CfnQuickResponse::QuickResponseContentProviderProperty (readonly)

The content of the quick response.

Returns:

See Also:



49
50
51
 
# File 'wisdom/cfn_quick_response_props.rb', line 49

def content
  @content
end

#content_type ⇒ String? (readonly)

The media type of the quick response content.

  • Use application/x.quickresponse;format=plain for quick response written in plain text.
  • Use application/x.quickresponse;format=markdown for quick response written in richtext.

Returns:

  • (String, nil)

See Also:



74
75
76
 
# File 'wisdom/cfn_quick_response_props.rb', line 74

def content_type
  @content_type
end

#description ⇒ String? (readonly)

The description of the quick response.

Returns:

  • (String, nil)

See Also:



79
80
81
 
# File 'wisdom/cfn_quick_response_props.rb', line 79

def description
  @description
end

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

The configuration information of the user groups that the quick response is accessible to.

Returns:

See Also:



84
85
86
 
# File 'wisdom/cfn_quick_response_props.rb', line 84

def grouping_configuration
  @grouping_configuration
end

#is_active ⇒ Boolean, ... (readonly)

Whether the quick response is active.

Returns:

See Also:



89
90
91
 
# File 'wisdom/cfn_quick_response_props.rb', line 89

def is_active
  @is_active
end

#knowledge_base_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the knowledge base.

Returns:

  • (String)

See Also:



54
55
56
 
# File 'wisdom/cfn_quick_response_props.rb', line 54

def knowledge_base_arn
  @knowledge_base_arn
end

#language ⇒ String? (readonly)

The language code value for the language in which the quick response is written.

The supported language codes include de_DE , en_US , es_ES , fr_FR , id_ID , it_IT , ja_JP , ko_KR , pt_BR , zh_CN , zh_TW

Returns:

  • (String, nil)

See Also:



96
97
98
 
# File 'wisdom/cfn_quick_response_props.rb', line 96

def language
  @language
end

#name ⇒ String (readonly)

The name of the quick response.

Returns:

  • (String)

See Also:



59
60
61
 
# File 'wisdom/cfn_quick_response_props.rb', line 59

def name
  @name
end

#shortcut_key ⇒ String? (readonly)

The shortcut key of the quick response.

The value should be unique across the knowledge base.

Returns:

  • (String, nil)

See Also:



103
104
105
 
# File 'wisdom/cfn_quick_response_props.rb', line 103

def shortcut_key
  @shortcut_key
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

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

Returns:

See Also:



108
109
110
 
# File 'wisdom/cfn_quick_response_props.rb', line 108

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'wisdom/cfn_quick_response_props.rb', line 110

def self.jsii_properties
  {
    :content => "content",
    :knowledge_base_arn => "knowledgeBaseArn",
    :name => "name",
    :channels => "channels",
    :content_type => "contentType",
    :description => "description",
    :grouping_configuration => "groupingConfiguration",
    :is_active => "isActive",
    :language => "language",
    :shortcut_key => "shortcutKey",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'wisdom/cfn_quick_response_props.rb', line 126

def to_jsii
  result = {}
  result.merge!({
    "content" => @content,
    "knowledgeBaseArn" => @knowledge_base_arn,
    "name" => @name,
    "channels" => @channels,
    "contentType" => @content_type,
    "description" => @description,
    "groupingConfiguration" => @grouping_configuration,
    "isActive" => @is_active,
    "language" => @language,
    "shortcutKey" => @shortcut_key,
    "tags" => @tags,
  })
  result.compact
end