1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. opensearchserverless
  5. getCollectionGroup

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.59.0
published on Monday, Mar 30, 2026 by Pulumi
 logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.59.0
published on Monday, Mar 30, 2026 by Pulumi

    Resource Type definition for AWS::OpenSearchServerless::CollectionGroup

    Using getCollectionGroup

    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 getCollectionGroup(args: GetCollectionGroupArgs, opts?: InvokeOptions): Promise<GetCollectionGroupResult>
    function getCollectionGroupOutput(args: GetCollectionGroupOutputArgs, opts?: InvokeOptions): Output<GetCollectionGroupResult>
    def get_collection_group(id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetCollectionGroupResult
    def get_collection_group_output(id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetCollectionGroupResult]
    func LookupCollectionGroup(ctx *Context, args *LookupCollectionGroupArgs, opts ...InvokeOption) (*LookupCollectionGroupResult, error)
    func LookupCollectionGroupOutput(ctx *Context, args *LookupCollectionGroupOutputArgs, opts ...InvokeOption) LookupCollectionGroupResultOutput

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

    public static class GetCollectionGroup 
    {
        public static Task<GetCollectionGroupResult> InvokeAsync(GetCollectionGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetCollectionGroupResult> Invoke(GetCollectionGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCollectionGroupResult> getCollectionGroup(GetCollectionGroupArgs args, InvokeOptions options)
    public static Output<GetCollectionGroupResult> getCollectionGroup(GetCollectionGroupArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aws-native:opensearchserverless:getCollectionGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The unique identifier of the collection group.
    Id string
    The unique identifier of the collection group.
    id String
    The unique identifier of the collection group.
    id string
    The unique identifier of the collection group.
    id str
    The unique identifier of the collection group.
    id String
    The unique identifier of the collection group.

    getCollectionGroup Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the collection group.
    CapacityLimits Pulumi.AwsNative.OpenSearchServerless.Outputs.CollectionGroupCapacityLimits
    Description string
    The description of the collection group.
    Id string
    The unique identifier of the collection group.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    Arn string
    The Amazon Resource Name (ARN) of the collection group.
    CapacityLimits CollectionGroupCapacityLimits
    Description string
    The description of the collection group.
    Id string
    The unique identifier of the collection group.
    Tags Tag
    An array of key-value pairs to apply to this resource.
    arn String
    The Amazon Resource Name (ARN) of the collection group.
    capacityLimits CollectionGroupCapacityLimits
    description String
    The description of the collection group.
    id String
    The unique identifier of the collection group.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    arn string
    The Amazon Resource Name (ARN) of the collection group.
    capacityLimits CollectionGroupCapacityLimits
    description string
    The description of the collection group.
    id string
    The unique identifier of the collection group.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    arn str
    The Amazon Resource Name (ARN) of the collection group.
    capacity_limits CollectionGroupCapacityLimits
    description str
    The description of the collection group.
    id str
    The unique identifier of the collection group.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    arn String
    The Amazon Resource Name (ARN) of the collection group.
    capacityLimits Property Map
    description String
    The description of the collection group.
    id String
    The unique identifier of the collection group.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Supporting Types

    CollectionGroupCapacityLimits

    MaxIndexingCapacityInOcu double
    The maximum indexing capacity for collections in the group.
    MaxSearchCapacityInOcu double
    The maximum search capacity for collections in the group.
    MinIndexingCapacityInOcu double
    The minimum indexing capacity for collections in the group.
    MinSearchCapacityInOcu double
    The minimum search capacity for collections in the group.
    MaxIndexingCapacityInOcu float64
    The maximum indexing capacity for collections in the group.
    MaxSearchCapacityInOcu float64
    The maximum search capacity for collections in the group.
    MinIndexingCapacityInOcu float64
    The minimum indexing capacity for collections in the group.
    MinSearchCapacityInOcu float64
    The minimum search capacity for collections in the group.
    maxIndexingCapacityInOcu Double
    The maximum indexing capacity for collections in the group.
    maxSearchCapacityInOcu Double
    The maximum search capacity for collections in the group.
    minIndexingCapacityInOcu Double
    The minimum indexing capacity for collections in the group.
    minSearchCapacityInOcu Double
    The minimum search capacity for collections in the group.
    maxIndexingCapacityInOcu number
    The maximum indexing capacity for collections in the group.
    maxSearchCapacityInOcu number
    The maximum search capacity for collections in the group.
    minIndexingCapacityInOcu number
    The minimum indexing capacity for collections in the group.
    minSearchCapacityInOcu number
    The minimum search capacity for collections in the group.
    max_indexing_capacity_in_ocu float
    The maximum indexing capacity for collections in the group.
    max_search_capacity_in_ocu float
    The maximum search capacity for collections in the group.
    min_indexing_capacity_in_ocu float
    The minimum indexing capacity for collections in the group.
    min_search_capacity_in_ocu float
    The minimum search capacity for collections in the group.
    maxIndexingCapacityInOcu Number
    The maximum indexing capacity for collections in the group.
    maxSearchCapacityInOcu Number
    The maximum search capacity for collections in the group.
    minIndexingCapacityInOcu Number
    The minimum indexing capacity for collections in the group.
    minSearchCapacityInOcu Number
    The minimum search capacity for collections in the group.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
     logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.59.0
    published on Monday, Mar 30, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.