AWS::OpenSearchServerless::Index - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::OpenSearchServerless::Index

An OpenSearch Serverless index resource.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::OpenSearchServerless::Index",
  "Properties" : {
      "CollectionEndpoint" : String,
      "IndexName" : String,
      "Mappings" : Mappings,
      "Settings" : IndexSettings
    }
}

YAML

Type: AWS::OpenSearchServerless::Index
Properties:
  CollectionEndpoint: String
  IndexName: String
  Mappings: 
    Mappings
  Settings: 
    IndexSettings

Properties

CollectionEndpoint

The endpoint for the collection.

Required: Yes

Type: String

Update requires: Replacement

IndexName

The name of the OpenSearch Serverless index.

Required: Yes

Type: String

Pattern: ^(?![_-])[a-z][a-z0-9_-]*$

Update requires: Replacement

Mappings

Index mappings for the OpenSearch Serverless index.

Required: No

Type: Mappings

Update requires: No interruption

Settings

Index settings for the OpenSearch Serverless index.

Required: No

Type: IndexSettings

Update requires: No interruption

Return values

Ref

The index name and the collection endpoint in the following format: index name|endpoint. Here's an example:

1234TestIndex|12345678TestEndPoint.us-east-1.aoss.amazonaws.com.

Fn::GetAtt

Uuid

The unique identifier for the index.