AWS::OpenSearchServerless::CollectionGroup - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::OpenSearchServerless::CollectionGroup

Creates a collection group within OpenSearch Serverless. Collection groups let you manage OpenSearch Compute Units (OCUs) at a group level, with multiple collections sharing the group's capacity limits.

For more information, see Managing collection groups.

Syntax

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

JSON

{
  "Type" : "AWS::OpenSearchServerless::CollectionGroup",
  "Properties" : {
      "CapacityLimits" : CapacityLimits,
      "Description" : String,
      "Name" : String,
      "StandbyReplicas" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::OpenSearchServerless::CollectionGroup
Properties:
  CapacityLimits: 
    CapacityLimits
  Description: String
  Name: String
  StandbyReplicas: String
  Tags: 
    - Tag

Properties

CapacityLimits

The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units (OCUs). These limits are used to scale your collections based on the current workload. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.

Required: No

Type: CapacityLimits

Update requires: No interruption

Description

The description of the collection group.

Required: No

Type: String

Maximum: 1000

Update requires: No interruption

Name

The name of the collection group.

Required: Yes

Type: String

Pattern: ^[a-z][a-z0-9-]{2,31}$

Minimum: 3

Maximum: 32

Update requires: Replacement

StandbyReplicas

Indicates whether standby replicas are used for the collection group. Can be either ENABLED or DISABLED.

Required: Yes

Type: String

Allowed values: ENABLED | DISABLED

Update requires: Replacement

Tags

An array of key-value pairs to apply to this resource.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the collection group ID. For more information about using the Ref function, see Ref.

Fn::GetAtt

Details about a collection group.

Arn

The Amazon Resource Name (ARN) of the collection group.

Id

The unique identifier of the collection group.