Create Collection Group

opensearchserviceserverless_create_collection_group

R Documentation

Creates a collection group within OpenSearch Serverless

Description

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.

Usage

opensearchserviceserverless_create_collection_group(name,
  standbyReplicas, description, tags, capacityLimits, clientToken)

Arguments

name	[required] The name of the collection group.
standbyReplicas	[required] Indicates whether standby replicas should be used for a collection group.
description	A description of the collection group.
tags	An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection group.
capacityLimits	The capacity limits for the collection group, in OpenSearch Compute Units (OCUs). These limits control the maximum and minimum capacity for collections within the group.
clientToken	Unique, case-sensitive identifier to ensure idempotency of the request.

Value

A list with the following syntax:

list(
  createCollectionGroupDetail = list(
    id = "string",
    arn = "string",
    name = "string",
    standbyReplicas = "ENABLED"|"DISABLED",
    description = "string",
    tags = list(
      list(
        key = "string",
        value = "string"
      )
    ),
    createdDate = 123,
    capacityLimits = list(
      maxIndexingCapacityInOCU = 123.0,
      maxSearchCapacityInOCU = 123.0,
      minIndexingCapacityInOCU = 123.0,
      minSearchCapacityInOCU = 123.0
    )
  )
)

Request syntax

svc$create_collection_group(
  name = "string",
  standbyReplicas = "ENABLED"|"DISABLED",
  description = "string",
  tags = list(
    list(
      key = "string",
      value = "string"
    )
  ),
  capacityLimits = list(
    maxIndexingCapacityInOCU = 123.0,
    maxSearchCapacityInOCU = 123.0,
    minIndexingCapacityInOCU = 123.0,
    minSearchCapacityInOCU = 123.0
  ),
  clientToken = "string"
)