Package software.amazon.awscdk.services.opensearchserverless

Interface IndexReference

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IndexReference.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-15T14:52:02.903Z")
@Stability(Stable)
public interface IndexReference
extends software.amazon.jsii.JsiiSerializable

A reference to a Index resource.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.opensearchserverless.*;
 IndexReference indexReference = IndexReference.builder()
         .collectionEndpoint("collectionEndpoint")
         .indexName("indexName")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	IndexReference.Builder	A builder for IndexReference
static final class	IndexReference.Jsii$Proxy	An implementation for IndexReference

Method Summary

Modifier and Type	Method	Description
static IndexReference.Builder	builder()
String	getCollectionEndpoint()	The CollectionEndpoint of the Index resource.
String	getIndexName()	The IndexName of the Index resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCollectionEndpoint

@Stability(Stable)
@NotNull
String getCollectionEndpoint()

The CollectionEndpoint of the Index resource.

getIndexName

@Stability(Stable)
@NotNull
String getIndexName()

The IndexName of the Index resource.

builder

@Stability(Stable)
static IndexReference.Builder builder()

Returns:

a IndexReference.Builder of IndexReference