Class: AWSCDK::Interfaces::AWSOpensearchserverless::IndexReference

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

Overview

A reference to a Index resource.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(collection_endpoint:, index_name:) ⇒ IndexReference

Returns a new instance of IndexReference.

Parameters:

  • collection_endpoint (String) —

    The CollectionEndpoint of the Index resource.

  • index_name (String) —

    The IndexName of the Index resource.



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

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

Instance Attribute Details

#collection_endpoint ⇒ String (readonly)

The CollectionEndpoint of the Index resource.

Returns:

  • (String) 


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

def collection_endpoint
  @collection_endpoint
end

#index_name ⇒ String (readonly)

The IndexName of the Index resource.

Returns:

  • (String) 


23
24
25
 
# File 'interfaces/aws_opensearchserverless/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/index_reference.rb', line 25

def self.jsii_properties
  {
    :collection_endpoint => "collectionEndpoint",
    :index_name => "indexName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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

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