Class: AWSCDK::Interfaces::AWSOpensearchserverless::CollectionIndexReference

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
interfaces/aws_opensearchserverless/collection_index_reference.rb

Overview

A reference to a CollectionIndex resource.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(collection_index_id:, index_name:) ⇒ CollectionIndexReference

Returns a new instance of CollectionIndexReference.

Parameters:

  • collection_index_id (String) —

    The Id of the CollectionIndex resource.

  • index_name (String) —

    The IndexName of the CollectionIndex resource.



9
10
11
12
13
14
 
# File 'interfaces/aws_opensearchserverless/collection_index_reference.rb', line 9

def initialize(collection_index_id:, index_name:)
  @collection_index_id = collection_index_id
  Jsii::Type.check_type(@collection_index_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "collectionIndexId")
  @index_name = index_name
  Jsii::Type.check_type(@index_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "indexName")
end

Instance Attribute Details

#collection_index_id ⇒ String (readonly)

The Id of the CollectionIndex resource.

Returns:

  • (String) 


19
20
21
 
# File 'interfaces/aws_opensearchserverless/collection_index_reference.rb', line 19

def collection_index_id
  @collection_index_id
end

#index_name ⇒ String (readonly)

The IndexName of the CollectionIndex resource.

Returns:

  • (String) 


23
24
25
 
# File 'interfaces/aws_opensearchserverless/collection_index_reference.rb', line 23

def index_name
  @index_name
end

Class Method Details

.jsii_properties ⇒ Object 



25
26
27
28
29
30
 
# File 'interfaces/aws_opensearchserverless/collection_index_reference.rb', line 25

def self.jsii_properties
  {
    :collection_index_id => "collectionIndexId",
    :index_name => "indexName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



32
33
34
35
36
37
38
39
 
# File 'interfaces/aws_opensearchserverless/collection_index_reference.rb', line 32

def to_jsii
  result = {}
  result.merge!({
    "collectionIndexId" => @collection_index_id,
    "indexName" => @index_name,
  })
  result.compact
end