AWS::OpenSearchServerless::CollectionGroup

OpenSearchServerless CollectionGroup

Resource Type definition for AWS::OpenSearchServerless::CollectionGroup

Properties

5 configurable properties. 2 required. Click a row to see details.

Filter:

Property	Type	Flags
`Name`	`string`	RequiredCreate-only
`StandbyReplicas`	`string`	RequiredCreate-only
`CapacityLimits`	`CapacityLimits`
`Description`	`string`
`Tags`	`Array<Tag>`

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 group.
`Id`	`string`	The unique identifier of the collection group.

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

Resources:
  MyResource:
    Type: AWS::OpenSearchServerless::CollectionGroup
    Properties:
      Name: "my-name"
      StandbyReplicas: "ENABLED"
      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:CreateCollectionGroupaoss:BatchGetCollectionGroupaoss:TagResource

read

aoss:BatchGetCollectionGroupaoss:ListTagsForResource

update

aoss:UpdateCollectionGroupaoss:BatchGetCollectionGroupaoss:TagResourceaoss:UntagResource

delete

aoss:DeleteCollectionGroupaoss:BatchGetCollectionGroup

list

aoss:ListCollectionGroups

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

Properties7

Required2

TaggingSupported

Primary IDId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

NameStandbyReplicas

Related Resources

External Links

AWS Documentation