1. Packages
  2. Packages
  3. AWS
  4. API Docs
  5. opensearch
  6. getServerlessCollectionGroup
Viewing docs for AWS v7.28.0
published on Thursday, Apr 30, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.opensearch.getServerlessCollectionGroup

aws logo
Viewing docs for AWS v7.28.0
published on Thursday, Apr 30, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Data source for managing an AWS OpenSearch Serverless Collection Group.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.opensearch.getServerlessCollectionGroup({
    name: "example-group",
});

    import pulumi
import pulumi_aws as aws

example = aws.opensearch.get_serverless_collection_group(name="example-group")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/opensearch"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := opensearch.LookupServerlessCollectionGroup(ctx, &opensearch.LookupServerlessCollectionGroupArgs{
			Name: pulumi.StringRef("example-group"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.OpenSearch.GetServerlessCollectionGroup.Invoke(new()
    {
        Name = "example-group",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.opensearch.OpensearchFunctions;
import com.pulumi.aws.opensearch.inputs.GetServerlessCollectionGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = OpensearchFunctions.getServerlessCollectionGroup(GetServerlessCollectionGroupArgs.builder()
            .name("example-group")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: aws:opensearch:getServerlessCollectionGroup
      arguments:
        name: example-group

    Using getServerlessCollectionGroup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getServerlessCollectionGroup(args: GetServerlessCollectionGroupArgs, opts?: InvokeOptions): Promise<GetServerlessCollectionGroupResult>
function getServerlessCollectionGroupOutput(args: GetServerlessCollectionGroupOutputArgs, opts?: InvokeOptions): Output<GetServerlessCollectionGroupResult>
    def get_serverless_collection_group(id: Optional[str] = None,
                                    name: Optional[str] = None,
                                    region: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetServerlessCollectionGroupResult
def get_serverless_collection_group_output(id: Optional[pulumi.Input[str]] = None,
                                    name: Optional[pulumi.Input[str]] = None,
                                    region: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetServerlessCollectionGroupResult]
    func LookupServerlessCollectionGroup(ctx *Context, args *LookupServerlessCollectionGroupArgs, opts ...InvokeOption) (*LookupServerlessCollectionGroupResult, error)
func LookupServerlessCollectionGroupOutput(ctx *Context, args *LookupServerlessCollectionGroupOutputArgs, opts ...InvokeOption) LookupServerlessCollectionGroupResultOutput

    > Note: This function is named LookupServerlessCollectionGroup in the Go SDK.

    public static class GetServerlessCollectionGroup 
{
    public static Task<GetServerlessCollectionGroupResult> InvokeAsync(GetServerlessCollectionGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetServerlessCollectionGroupResult> Invoke(GetServerlessCollectionGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetServerlessCollectionGroupResult> getServerlessCollectionGroup(GetServerlessCollectionGroupArgs args, InvokeOptions options)
public static Output<GetServerlessCollectionGroupResult> getServerlessCollectionGroup(GetServerlessCollectionGroupArgs args, InvokeOptions options)

    fn::invoke:
  function: aws:opensearch/getServerlessCollectionGroup:getServerlessCollectionGroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    ID of the collection group.
    Name string
    Name of the collection group.
    Region string

    Region where this resource will be managed. Defaults to the Region set in the provider configuration.

    Specify exactly one of id or name.

    Id string
    ID of the collection group.
    Name string
    Name of the collection group.
    Region string

    Region where this resource will be managed. Defaults to the Region set in the provider configuration.

    Specify exactly one of id or name.

    id String
    ID of the collection group.
    name String
    Name of the collection group.
    region String

    Region where this resource will be managed. Defaults to the Region set in the provider configuration.

    Specify exactly one of id or name.

    id string
    ID of the collection group.
    name string
    Name of the collection group.
    region string

    Region where this resource will be managed. Defaults to the Region set in the provider configuration.

    Specify exactly one of id or name.

    id str
    ID of the collection group.
    name str
    Name of the collection group.
    region str

    Region where this resource will be managed. Defaults to the Region set in the provider configuration.

    Specify exactly one of id or name.

    id String
    ID of the collection group.
    name String
    Name of the collection group.
    region String

    Region where this resource will be managed. Defaults to the Region set in the provider configuration.

    Specify exactly one of id or name.

    getServerlessCollectionGroup Result

    The following output properties are available:

    Arn string
    Amazon Resource Name (ARN) of the collection group.
    CapacityLimits List<GetServerlessCollectionGroupCapacityLimit>
    Capacity limits configured for the collection group. See capacityLimits below for details.
    CreatedDate string
    Date the collection group was created.
    Description string
    Description of the collection group.
    Id string
    Name string
    Region string
    StandbyReplicas string
    Indicates whether standby replicas should be used for collections in this group.
    Tags Dictionary<string, string>
    A map of tags assigned to the collection group.
    Arn string
    Amazon Resource Name (ARN) of the collection group.
    CapacityLimits []GetServerlessCollectionGroupCapacityLimit
    Capacity limits configured for the collection group. See capacityLimits below for details.
    CreatedDate string
    Date the collection group was created.
    Description string
    Description of the collection group.
    Id string
    Name string
    Region string
    StandbyReplicas string
    Indicates whether standby replicas should be used for collections in this group.
    Tags map[string]string
    A map of tags assigned to the collection group.
    arn String
    Amazon Resource Name (ARN) of the collection group.
    capacityLimits List<GetServerlessCollectionGroupCapacityLimit>
    Capacity limits configured for the collection group. See capacityLimits below for details.
    createdDate String
    Date the collection group was created.
    description String
    Description of the collection group.
    id String
    name String
    region String
    standbyReplicas String
    Indicates whether standby replicas should be used for collections in this group.
    tags Map<String,String>
    A map of tags assigned to the collection group.
    arn string
    Amazon Resource Name (ARN) of the collection group.
    capacityLimits GetServerlessCollectionGroupCapacityLimit[]
    Capacity limits configured for the collection group. See capacityLimits below for details.
    createdDate string
    Date the collection group was created.
    description string
    Description of the collection group.
    id string
    name string
    region string
    standbyReplicas string
    Indicates whether standby replicas should be used for collections in this group.
    tags {[key: string]: string}
    A map of tags assigned to the collection group.
    arn str
    Amazon Resource Name (ARN) of the collection group.
    capacity_limits Sequence[GetServerlessCollectionGroupCapacityLimit]
    Capacity limits configured for the collection group. See capacityLimits below for details.
    created_date str
    Date the collection group was created.
    description str
    Description of the collection group.
    id str
    name str
    region str
    standby_replicas str
    Indicates whether standby replicas should be used for collections in this group.
    tags Mapping[str, str]
    A map of tags assigned to the collection group.
    arn String
    Amazon Resource Name (ARN) of the collection group.
    capacityLimits List<Property Map>
    Capacity limits configured for the collection group. See capacityLimits below for details.
    createdDate String
    Date the collection group was created.
    description String
    Description of the collection group.
    id String
    name String
    region String
    standbyReplicas String
    Indicates whether standby replicas should be used for collections in this group.
    tags Map<String>
    A map of tags assigned to the collection group.

    Supporting Types

    GetServerlessCollectionGroupCapacityLimit

    MaxIndexingCapacityInOcu double
    Maximum indexing capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    MaxSearchCapacityInOcu double
    Maximum search capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    MinIndexingCapacityInOcu double
    Minimum indexing capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    MinSearchCapacityInOcu double
    Minimum search capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    MaxIndexingCapacityInOcu float64
    Maximum indexing capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    MaxSearchCapacityInOcu float64
    Maximum search capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    MinIndexingCapacityInOcu float64
    Minimum indexing capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    MinSearchCapacityInOcu float64
    Minimum search capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    maxIndexingCapacityInOcu Double
    Maximum indexing capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    maxSearchCapacityInOcu Double
    Maximum search capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    minIndexingCapacityInOcu Double
    Minimum indexing capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    minSearchCapacityInOcu Double
    Minimum search capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    maxIndexingCapacityInOcu number
    Maximum indexing capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    maxSearchCapacityInOcu number
    Maximum search capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    minIndexingCapacityInOcu number
    Minimum indexing capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    minSearchCapacityInOcu number
    Minimum search capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    max_indexing_capacity_in_ocu float
    Maximum indexing capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    max_search_capacity_in_ocu float
    Maximum search capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    min_indexing_capacity_in_ocu float
    Minimum indexing capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    min_search_capacity_in_ocu float
    Minimum search capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    maxIndexingCapacityInOcu Number
    Maximum indexing capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    maxSearchCapacityInOcu Number
    Maximum search capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    minIndexingCapacityInOcu Number
    Minimum indexing capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    minSearchCapacityInOcu Number
    Minimum search capacity, in OpenSearch Compute Units (OCUs), for the collection group.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    Viewing docs for AWS v7.28.0
    published on Thursday, Apr 30, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws
      Try Pulumi Cloud free. Your team will thank you.