Class: AWSCDK::QBusiness::CfnIndexProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
q_business/cfn_index_props.rb

Overview

Properties for defining a CfnIndex.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(application_id:, display_name:, capacity_configuration: nil, description: nil, document_attribute_configurations: nil, tags: nil, type: nil) ⇒ CfnIndexProps

Returns a new instance of CfnIndexProps.

Parameters:



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'q_business/cfn_index_props.rb', line 16

def initialize(application_id:, display_name:, capacity_configuration: nil, description: nil, document_attribute_configurations: nil, tags: nil, type: nil)
  @application_id = application_id
  Jsii::Type.check_type(@application_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationId")
  @display_name = display_name
  Jsii::Type.check_type(@display_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "displayName")
  @capacity_configuration = capacity_configuration.is_a?(Hash) ? ::AWSCDK::QBusiness::CfnIndex::IndexCapacityConfigurationProperty.new(**capacity_configuration.transform_keys(&:to_sym)) : capacity_configuration
  Jsii::Type.check_type(@capacity_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xYnVzaW5lc3MuQ2ZuSW5kZXguSW5kZXhDYXBhY2l0eUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "capacityConfiguration") unless @capacity_configuration.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @document_attribute_configurations = document_attribute_configurations
  Jsii::Type.check_type(@document_attribute_configurations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcWJ1c2luZXNzLkNmbkluZGV4LkRvY3VtZW50QXR0cmlidXRlQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "documentAttributeConfigurations") unless @document_attribute_configurations.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?
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless @type.nil?
end

Instance Attribute Details

#application_id ⇒ String (readonly)

The identifier of the Amazon Q Business application using the index.

Returns:

  • (String)

See Also:



37
38
39
 
# File 'q_business/cfn_index_props.rb', line 37

def application_id
  @application_id
end

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

The capacity units you want to provision for your index.

You can add and remove capacity to fit your usage needs.

Returns:

See Also:



49
50
51
 
# File 'q_business/cfn_index_props.rb', line 49

def capacity_configuration
  @capacity_configuration
end

#description ⇒ String? (readonly)

A description for the Amazon Q Business index.

Returns:

  • (String, nil)

See Also:



54
55
56
 
# File 'q_business/cfn_index_props.rb', line 54

def description
  @description
end

#display_name ⇒ String (readonly)

The name of the index.

Returns:

  • (String)

See Also:



42
43
44
 
# File 'q_business/cfn_index_props.rb', line 42

def display_name
  @display_name
end

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

Configuration information for document attributes.

Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

For more information, see Understanding document attributes .

Returns:

See Also:



63
64
65
 
# File 'q_business/cfn_index_props.rb', line 63

def document_attribute_configurations
  @document_attribute_configurations
end

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

A list of key-value pairs that identify or categorize the index.

You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -

Returns:

See Also:



70
71
72
 
# File 'q_business/cfn_index_props.rb', line 70

def tags
  @tags
end

#type ⇒ String? (readonly)

The index type that's suitable for your needs.

For more information on what's included in each type of index, see Amazon Q Business tiers .

Returns:

  • (String, nil)

See Also:



77
78
79
 
# File 'q_business/cfn_index_props.rb', line 77

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
 
# File 'q_business/cfn_index_props.rb', line 79

def self.jsii_properties
  {
    :application_id => "applicationId",
    :display_name => "displayName",
    :capacity_configuration => "capacityConfiguration",
    :description => "description",
    :document_attribute_configurations => "documentAttributeConfigurations",
    :tags => "tags",
    :type => "type",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'q_business/cfn_index_props.rb', line 91

def to_jsii
  result = {}
  result.merge!({
    "applicationId" => @application_id,
    "displayName" => @display_name,
    "capacityConfiguration" => @capacity_configuration,
    "description" => @description,
    "documentAttributeConfigurations" => @document_attribute_configurations,
    "tags" => @tags,
    "type" => @type,
  })
  result.compact
end