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

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
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.opensearchserverless.CollectionGroup

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
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for AWS::OpenSearchServerless::CollectionGroup

    Create CollectionGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CollectionGroup(name: string, args: CollectionGroupArgs, opts?: CustomResourceOptions);
    @overload
def CollectionGroup(resource_name: str,
                    args: CollectionGroupArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def CollectionGroup(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    standby_replicas: Optional[CollectionGroupStandbyReplicas] = None,
                    capacity_limits: Optional[CollectionGroupCapacityLimitsArgs] = None,
                    description: Optional[str] = None,
                    name: Optional[str] = None,
                    tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewCollectionGroup(ctx *Context, name string, args CollectionGroupArgs, opts ...ResourceOption) (*CollectionGroup, error)
    public CollectionGroup(string name, CollectionGroupArgs args, CustomResourceOptions? opts = null)
    public CollectionGroup(String name, CollectionGroupArgs args)
public CollectionGroup(String name, CollectionGroupArgs args, CustomResourceOptions options)

    type: aws-native:opensearchserverless:CollectionGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args CollectionGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CollectionGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CollectionGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CollectionGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CollectionGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    CollectionGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The CollectionGroup resource accepts the following input properties:

    StandbyReplicas Pulumi.AwsNative.OpenSearchServerless.CollectionGroupStandbyReplicas
    Indicates whether standby replicas are used for the collection group.
    CapacityLimits Pulumi.AwsNative.OpenSearchServerless.Inputs.CollectionGroupCapacityLimits
    Description string
    The description of the collection group.
    Name string
    The name of the collection group.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    StandbyReplicas CollectionGroupStandbyReplicas
    Indicates whether standby replicas are used for the collection group.
    CapacityLimits CollectionGroupCapacityLimitsArgs
    Description string
    The description of the collection group.
    Name string
    The name of the collection group.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    standbyReplicas CollectionGroupStandbyReplicas
    Indicates whether standby replicas are used for the collection group.
    capacityLimits CollectionGroupCapacityLimits
    description String
    The description of the collection group.
    name String
    The name of the collection group.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    standbyReplicas CollectionGroupStandbyReplicas
    Indicates whether standby replicas are used for the collection group.
    capacityLimits CollectionGroupCapacityLimits
    description string
    The description of the collection group.
    name string
    The name of the collection group.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    standby_replicas CollectionGroupStandbyReplicas
    Indicates whether standby replicas are used for the collection group.
    capacity_limits CollectionGroupCapacityLimitsArgs
    description str
    The description of the collection group.
    name str
    The name of the collection group.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    standbyReplicas "ENABLED" | "DISABLED"
    Indicates whether standby replicas are used for the collection group.
    capacityLimits Property Map
    description String
    The description of the collection group.
    name String
    The name of the collection group.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CollectionGroup resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the collection group.
    AwsId string
    The unique identifier of the collection group.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The Amazon Resource Name (ARN) of the collection group.
    AwsId string
    The unique identifier of the collection group.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the collection group.
    awsId String
    The unique identifier of the collection group.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The Amazon Resource Name (ARN) of the collection group.
    awsId string
    The unique identifier of the collection group.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The Amazon Resource Name (ARN) of the collection group.
    aws_id str
    The unique identifier of the collection group.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the collection group.
    awsId String
    The unique identifier of the collection group.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    CollectionGroupCapacityLimits, CollectionGroupCapacityLimitsArgs

    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.

    CollectionGroupStandbyReplicas, CollectionGroupStandbyReplicasArgs

    Enabled
    ENABLED
    Disabled
    DISABLED
    CollectionGroupStandbyReplicasEnabled
    ENABLED
    CollectionGroupStandbyReplicasDisabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    ENABLED
    ENABLED
    DISABLED
    DISABLED
    "ENABLED"
    ENABLED
    "DISABLED"
    DISABLED

    Tag, TagArgs

    A set of tags to apply to the resource.
    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
    Schema (JSON)
    pulumi/pulumi-aws-native
      Try Pulumi Cloud free. Your team will thank you.