AWS::OpenSearchServerless::Collection

OpenSearchServerless Collection

Amazon OpenSearchServerless collection resource

Properties

7 configurable properties. 1 required. Click a row to see details.

Filter:

Property	Type	Flags
`Name`	`string`	RequiredCreate-only
`CollectionGroupName`	`string`	Create-only
`Description`	`string`
`EncryptionConfig`	`EncryptionConfig`	Create-onlyWrite-only
`StandbyReplicas`	`string`	Create-only
`Tags`	`Array<Tag>`	Create-onlyWrite-only
`Type`	`string`	Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`Arn`	`string`	The Amazon Resource Name (ARN) of the collection.
`CollectionEndpoint`	`string`	The endpoint for the collection.
`DashboardEndpoint`	`string`	The OpenSearch Dashboards endpoint for the collection.
`Id`	`string`	The identifier of the collection
`KmsKeyArn`	`string`	Key Management Service key used to encrypt the collection.

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::Collection

Resources:
  MyResource:
    Type: AWS::OpenSearchServerless::Collection
    Properties:
      Name: "my-name"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

aoss:CreateCollectionaoss:BatchGetCollectionaoss:AddCollectionToCollectionGroupiam:CreateServiceLinkedRolekms:CreateGrantkms:DescribeKey

delete

aoss:DeleteCollectionaoss:BatchGetCollection

list

aoss:ListCollections

read

aoss:BatchGetCollection

update

aoss:UpdateCollectionaoss:BatchGetCollection

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

ServiceOpenSearchServerless

Properties12

Required1

TaggingSupported

Primary IDId

Supported Operations

CreateDeleteListReadUpdate

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

NameTagsTypeStandbyReplicasCollectionGroupNameEncryptionConfig

Related Resources

External Links

AWS Documentation