ServerlessCollectionGroup class
Resource for managing an AWS OpenSearch Serverless Collection Group.
Collection groups let multiple OpenSearch Serverless collections share compute resources while keeping encryption and access controls independent.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.opensearch.ServerlessCollectionGroup("example", {
capacityLimits: [{
minIndexingCapacityInOcu: 2,
maxIndexingCapacityInOcu: 16,
minSearchCapacityInOcu: 2,
maxSearchCapacityInOcu: 16,
}],
name: "example-group",
description: "Shared compute for production collections",
standbyReplicas: "ENABLED",
});
import pulumi
import pulumi_aws as aws
example = aws.opensearch.ServerlessCollectionGroup("example",
capacity_limits=[{
"min_indexing_capacity_in_ocu": float(2),
"max_indexing_capacity_in_ocu": float(16),
"min_search_capacity_in_ocu": float(2),
"max_search_capacity_in_ocu": float(16),
}],
name="example-group",
description="Shared compute for production collections",
standby_replicas="ENABLED")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.OpenSearch.ServerlessCollectionGroup("example", new()
{
CapacityLimits = new[]
{
new Aws.OpenSearch.Inputs.ServerlessCollectionGroupCapacityLimitArgs
{
MinIndexingCapacityInOcu = 2,
MaxIndexingCapacityInOcu = 16,
MinSearchCapacityInOcu = 2,
MaxSearchCapacityInOcu = 16,
},
},
Name = "example-group",
Description = "Shared compute for production collections",
StandbyReplicas = "ENABLED",
});
});
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.NewServerlessCollectionGroup(ctx, "example", &opensearch.ServerlessCollectionGroupArgs{
CapacityLimits: opensearch.ServerlessCollectionGroupCapacityLimitArray{
&opensearch.ServerlessCollectionGroupCapacityLimitArgs{
MinIndexingCapacityInOcu: pulumi.Float64(2),
MaxIndexingCapacityInOcu: pulumi.Float64(16),
MinSearchCapacityInOcu: pulumi.Float64(2),
MaxSearchCapacityInOcu: pulumi.Float64(16),
},
},
Name: pulumi.String("example-group"),
Description: pulumi.String("Shared compute for production collections"),
StandbyReplicas: pulumi.String("ENABLED"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_opensearch_serverlesscollectiongroup" "example" {
capacity_limits {
min_indexing_capacity_in_ocu = 2
max_indexing_capacity_in_ocu = 16
min_search_capacity_in_ocu = 2
max_search_capacity_in_ocu = 16
}
name = "example-group"
description = "Shared compute for production collections"
standby_replicas = "ENABLED"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.opensearch.ServerlessCollectionGroup;
import com.pulumi.aws.opensearch.ServerlessCollectionGroupArgs;
import com.pulumi.aws.opensearch.inputs.ServerlessCollectionGroupCapacityLimitArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
var example = new ServerlessCollectionGroup("example", ServerlessCollectionGroupArgs.builder()
.capacityLimits(ServerlessCollectionGroupCapacityLimitArgs.builder()
.minIndexingCapacityInOcu(2.0)
.maxIndexingCapacityInOcu(16.0)
.minSearchCapacityInOcu(2.0)
.maxSearchCapacityInOcu(16.0)
.build())
.name("example-group")
.description("Shared compute for production collections")
.standbyReplicas("ENABLED")
.build());
}
}
resources:
example:
type: aws:opensearch:ServerlessCollectionGroup
properties:
capacityLimits:
- minIndexingCapacityInOcu: 2
maxIndexingCapacityInOcu: 16
minSearchCapacityInOcu: 2
maxSearchCapacityInOcu: 16
name: example-group
description: Shared compute for production collections
standbyReplicas: ENABLED
Import
Identity Schema
Required
id(String) Unique identifier for the collection group.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import OpenSearch Serverless Collection Group using the id. For example:
$ pulumi import aws:opensearch/serverlessCollectionGroup:ServerlessCollectionGroup example example-group-id
Constructors
- ServerlessCollectionGroup(String name, {ServerlessCollectionGroupArgs? args, CustomResourceOptions? options})
-
Creates a new ServerlessCollectionGroup.
nameThe Pulumi resource name.argsArguments used to configure this ServerlessCollectionGroup. The set of arguments for ServerlessCollectionGroup.optionsResource options controlling this resource's behavior. - ServerlessCollectionGroup.reference(String urn)
- Creates a typed reference to an existing ServerlessCollectionGroup resource.
Properties
-
arn
↔ Output<
String> -
ARN of the collection group.
latefinal
-
capacityLimits
↔ Output<
List< ServerlessCollectionGroupCapacityLimit> > -
Configuration block for the collection group's indexing and search capacity limits. See
capacityLimitsbelow for details.latefinal -
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
createdDate
↔ Output<
String> -
Date the collection group was created.
latefinal
-
description
↔ Output<
String?> -
Description of the collection group.
latefinal
-
generation
↔ Output<
String> -
Generation of Amazon OpenSearch Serverless for the collection group. Valid values are
CLASSICandNEXTGEN. Default value isCLASSIC.latefinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
Name of the collection group.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
standbyReplicas
↔ Output<
String> -
Indicates whether standby replicas should be used for collections in this group. Valid values are
ENABLEDandDISABLED. Ifgenerationis set toNEXTGEN, this argument must be set toENABLED.latefinal -
A map of tags to assign to the collection group. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {ServerlessCollectionGroupState? state, CustomResourceOptions? options}) → ServerlessCollectionGroup -
Gets an existing ServerlessCollectionGroup resource's state with the given
nameandid.