AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::OpenSearchServerless::Index

CfnIndex

An OpenSearch Serverless index resource.

Import

import { CfnIndex } from 'aws-cdk-lib/aws-opensearchserverless';

Or use the module namespace:

import * as opensearchserverless from 'aws-cdk-lib/aws-opensearchserverless';
// opensearchserverless.CfnIndex

Properties

Configuration passed to the constructor as CfnIndexProps.

collectionEndpointRequired
string

The endpoint for the collection.

indexNameRequired
string

The name of the OpenSearch Serverless index.

mappingsOptional
IResolvable | MappingsProperty

Index mappings for the OpenSearch Serverless index.

settingsOptional
IResolvable | IndexSettingsProperty

Index settings for the OpenSearch Serverless index.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-opensearchserverless
CFN TypeAWS::OpenSearchServerless::Index
Properties4

External Links