Skip to content

CreateCollectionGroupRequest

Source code in docs_src/capo_opensearchserverless/types/create_collection_group_request.py
class CreateCollectionGroupRequest(TypedDict, closed=True):
    name: "capo_opensearchserverless.types.collection_group_name.CollectionGroupName"
    """<p>The name of the collection group.</p>"""
    standby_replicas: "capo_opensearchserverless.types.standby_replicas.StandbyReplicas"
    """<p>Indicates whether standby replicas should be used for a collection group.</p>"""
    description: NotRequired["str"]
    """<p>A description of the collection group.</p>"""
    tags: NotRequired["capo_opensearchserverless.types.tags.Tags"]
    """<p>An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection group.</p>"""
    capacity_limits: NotRequired[
        "capo_opensearchserverless.types.collection_group_capacity_limits.CollectionGroupCapacityLimits"
    ]
    """<p>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.</p>"""
    generation: NotRequired[
        "capo_opensearchserverless.types.serverless_generation.ServerlessGeneration"
    ]
    """<p>The generation of Amazon OpenSearch Serverless for the collection group. Valid values are <code>CLASSIC</code> and <code>NEXTGEN</code>.</p>"""
    client_token: NotRequired[
        "capo_opensearchserverless.types.client_token.ClientToken"
    ]
    """<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>"""

capacity_limits instance-attribute

capacity_limits: NotRequired[CollectionGroupCapacityLimits]

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.

client_token instance-attribute

client_token: NotRequired[ClientToken]

Unique, case-sensitive identifier to ensure idempotency of the request.

description instance-attribute

description: NotRequired[str]

A description of the collection group.

generation instance-attribute

generation: NotRequired[ServerlessGeneration]

The generation of Amazon OpenSearch Serverless for the collection group. Valid values are CLASSIC and NEXTGEN.

name instance-attribute

The name of the collection group.

standby_replicas instance-attribute

standby_replicas: StandbyReplicas

Indicates whether standby replicas should be used for a collection group.

tags instance-attribute

tags: NotRequired[Tags]

An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection group.