AWS::OpenSearchServerless::IndexOpenSearchServerless Index
An OpenSearch Serverless index resource
Properties
4 configurable properties. 2 required. Click a row to see details.
Filter:
| Property | Type | Flags |
|---|---|---|
CollectionEndpoint | string | RequiredCreate-only |
IndexName | string | RequiredCreate-only |
Mappings | object | |
Settings | IndexSettings |
Return Values
Values returned after the resource is created. Access these with Fn::GetAtt.
| Attribute | Type | Description |
|---|---|---|
Uuid | string | The unique identifier for the index. |
Sample CloudFormation Template
A minimal template with required properties and common optional ones.
template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::OpenSearchServerless::Index
Resources:
MyResource:
Type: AWS::OpenSearchServerless::Index
Properties:
CollectionEndpoint: "value"
IndexName: "my-indexname"Required IAM Permissions
Permissions CloudFormation needs in your IAM role to manage this resource.
create
aoss:APIAccessAllread
aoss:APIAccessAllupdate
aoss:APIAccessAlldelete
aoss:APIAccessAlllist
aoss:APIAccessAllLearn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
ServiceOpenSearchServerless
Properties5
Required2
TaggingNot supported
Primary ID
IndexNameSupported Operations
CreateReadUpdateDeleteList
Immutable After Creation
These properties cannot be changed after the resource is created. Updating them triggers a replacement.
IndexNameCollectionEndpoint