Class: AWSCDK::OpenSearchServerless::CfnCollectionIndexProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
open_search_serverless/cfn_collection_index_props.rb

Overview

Properties for defining a CfnCollectionIndex.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id:, index_name:, index_schema: nil) ⇒ CfnCollectionIndexProps

Returns a new instance of CfnCollectionIndexProps.

Parameters:

  • id (String) —

    The identifier of the collection.

  • index_name (String) —

    The name of the collection index.

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

    The Mappings for the collection index.



12
13
14
15
16
17
18
19
 
# File 'open_search_serverless/cfn_collection_index_props.rb', line 12

def initialize(id:, index_name:, index_schema: nil)
  @id = id
  Jsii::Type.check_type(@id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  @index_name = index_name
  Jsii::Type.check_type(@index_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "indexName")
  @index_schema = index_schema
  Jsii::Type.check_type(@index_schema, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "indexSchema") unless @index_schema.nil?
end

Instance Attribute Details

#id ⇒ String (readonly)

The identifier of the collection.

Returns:

  • (String)

See Also:



25
26
27
 
# File 'open_search_serverless/cfn_collection_index_props.rb', line 25

def id
  @id
end

#index_name ⇒ String (readonly)

The name of the collection index.

Returns:

  • (String)

See Also:



30
31
32
 
# File 'open_search_serverless/cfn_collection_index_props.rb', line 30

def index_name
  @index_name
end

#index_schema ⇒ String? (readonly)

The Mappings for the collection index.

Returns:

  • (String, nil)

See Also:



35
36
37
 
# File 'open_search_serverless/cfn_collection_index_props.rb', line 35

def index_schema
  @index_schema
end

Class Method Details

.jsii_properties ⇒ Object 



37
38
39
40
41
42
43
 
# File 'open_search_serverless/cfn_collection_index_props.rb', line 37

def self.jsii_properties
  {
    :id => "id",
    :index_name => "indexName",
    :index_schema => "indexSchema",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



45
46
47
48
49
50
51
52
53
 
# File 'open_search_serverless/cfn_collection_index_props.rb', line 45

def to_jsii
  result = {}
  result.merge!({
    "id" => @id,
    "indexName" => @index_name,
    "indexSchema" => @index_schema,
  })
  result.compact
end