ServerlessCollection class
Manages an AWS OpenSearch Serverless Collection.
> NOTE: An aws.opensearch.ServerlessCollection must have encryption configured either by an applicable encryption security policy or by setting encryptionConfig directly on the resource.
> NOTE: An aws.opensearch.ServerlessCollection is not accessible without configuring an applicable network security policy. Data cannot be accessed without configuring an applicable data access policy.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.opensearch.ServerlessSecurityPolicy("example", {
name: "example",
type: "encryption",
policy: JSON.stringify({
Rules: [{
Resource: ["collection/example"],
ResourceType: "collection",
}],
AWSOwnedKey: true,
}),
});
const exampleServerlessCollection = new aws.opensearch.ServerlessCollection("example", {name: "example"}, {
dependsOn: [example],
});
import pulumi
import json
import pulumi_aws as aws
example = aws.opensearch.ServerlessSecurityPolicy("example",
name="example",
type="encryption",
policy=json.dumps({
"Rules": [{
"Resource": ["collection/example"],
"ResourceType": "collection",
}],
"AWSOwnedKey": True,
}))
example_serverless_collection = aws.opensearch.ServerlessCollection("example", name="example",
opts = pulumi.ResourceOptions(depends_on=[example]))
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.OpenSearch.ServerlessSecurityPolicy("example", new()
{
Name = "example",
Type = "encryption",
Policy = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["Rules"] = new[]
{
new Dictionary<string, object?>
{
["Resource"] = new[]
{
"collection/example",
},
["ResourceType"] = "collection",
},
},
["AWSOwnedKey"] = true,
}),
});
var exampleServerlessCollection = new Aws.OpenSearch.ServerlessCollection("example", new()
{
Name = "example",
}, new CustomResourceOptions
{
DependsOn =
{
example,
},
});
});
package main
import (
"encoding/json"
"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 {
tmpJSON0, err := json.Marshal(map[string]interface{}{
"Rules": []map[string]interface{}{
map[string]interface{}{
"Resource": []string{
"collection/example",
},
"ResourceType": "collection",
},
},
"AWSOwnedKey": true,
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
example, err := opensearch.NewServerlessSecurityPolicy(ctx, "example", &opensearch.ServerlessSecurityPolicyArgs{
Name: pulumi.String("example"),
Type: pulumi.String("encryption"),
Policy: pulumi.String(json0),
})
if err != nil {
return err
}
_, err = opensearch.NewServerlessCollection(ctx, "example", &opensearch.ServerlessCollectionArgs{
Name: pulumi.String("example"),
}, pulumi.DependsOn([]pulumi.Resource{
example,
}))
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_opensearch_serverlesssecuritypolicy" "example" {
name = "example"
type = "encryption"
policy = jsonencode({
"Rules" = [{
"Resource" = ["collection/example"]
"ResourceType" = "collection"
}]
"AWSOwnedKey" = true
})
}
resource "aws_opensearch_serverlesscollection" "example" {
depends_on = [aws_opensearch_serverlesssecuritypolicy.example]
name = "example"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.opensearch.ServerlessSecurityPolicy;
import com.pulumi.aws.opensearch.ServerlessSecurityPolicyArgs;
import com.pulumi.aws.opensearch.ServerlessCollection;
import com.pulumi.aws.opensearch.ServerlessCollectionArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import com.pulumi.resources.CustomResourceOptions;
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 ServerlessSecurityPolicy("example", ServerlessSecurityPolicyArgs.builder()
.name("example")
.type("encryption")
.policy(serializeJson(
jsonObject(
jsonProperty("Rules", jsonArray(jsonObject(
jsonProperty("Resource", jsonArray("collection/example")),
jsonProperty("ResourceType", "collection")
))),
jsonProperty("AWSOwnedKey", true)
)))
.build());
var exampleServerlessCollection = new ServerlessCollection("exampleServerlessCollection", ServerlessCollectionArgs.builder()
.name("example")
.build(), CustomResourceOptions.builder()
.dependsOn(example)
.build());
}
}
resources:
example:
type: aws:opensearch:ServerlessSecurityPolicy
properties:
name: example
type: encryption
policy:
fn::toJSON:
Rules:
- Resource:
- collection/example
ResourceType: collection
AWSOwnedKey: true
exampleServerlessCollection:
type: aws:opensearch:ServerlessCollection
name: example
properties:
name: example
options:
dependsOn:
- ${example}
With a Collection Group and Direct Encryption Configuration
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.kms.Key("example", {
description: "example",
deletionWindowInDays: 7,
});
const exampleServerlessCollectionGroup = new aws.opensearch.ServerlessCollectionGroup("example", {
name: "example-group",
standbyReplicas: "ENABLED",
});
const exampleServerlessCollection = new aws.opensearch.ServerlessCollection("example", {
encryptionConfigs: [{
kmsKeyArn: example.arn,
}],
name: "example",
type: "SEARCH",
collectionGroupName: exampleServerlessCollectionGroup.name,
});
import pulumi
import pulumi_aws as aws
example = aws.kms.Key("example",
description="example",
deletion_window_in_days=7)
example_serverless_collection_group = aws.opensearch.ServerlessCollectionGroup("example",
name="example-group",
standby_replicas="ENABLED")
example_serverless_collection = aws.opensearch.ServerlessCollection("example",
encryption_configs=[{
"kms_key_arn": example.arn,
}],
name="example",
type="SEARCH",
collection_group_name=example_serverless_collection_group.name)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Kms.Key("example", new()
{
Description = "example",
DeletionWindowInDays = 7,
});
var exampleServerlessCollectionGroup = new Aws.OpenSearch.ServerlessCollectionGroup("example", new()
{
Name = "example-group",
StandbyReplicas = "ENABLED",
});
var exampleServerlessCollection = new Aws.OpenSearch.ServerlessCollection("example", new()
{
EncryptionConfigs = new[]
{
new Aws.OpenSearch.Inputs.ServerlessCollectionEncryptionConfigArgs
{
KmsKeyArn = example.Arn,
},
},
Name = "example",
Type = "SEARCH",
CollectionGroupName = exampleServerlessCollectionGroup.Name,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/kms"
"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 {
example, err := kms.NewKey(ctx, "example", &kms.KeyArgs{
Description: pulumi.String("example"),
DeletionWindowInDays: pulumi.Int(7),
})
if err != nil {
return err
}
exampleServerlessCollectionGroup, err := opensearch.NewServerlessCollectionGroup(ctx, "example", &opensearch.ServerlessCollectionGroupArgs{
Name: pulumi.String("example-group"),
StandbyReplicas: pulumi.String("ENABLED"),
})
if err != nil {
return err
}
_, err = opensearch.NewServerlessCollection(ctx, "example", &opensearch.ServerlessCollectionArgs{
EncryptionConfigs: opensearch.ServerlessCollectionEncryptionConfigArray{
&opensearch.ServerlessCollectionEncryptionConfigArgs{
KmsKeyArn: example.Arn,
},
},
Name: pulumi.String("example"),
Type: pulumi.String("SEARCH"),
CollectionGroupName: exampleServerlessCollectionGroup.Name,
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_kms_key" "example" {
description = "example"
deletion_window_in_days = 7
}
resource "aws_opensearch_serverlesscollectiongroup" "example" {
name = "example-group"
standby_replicas = "ENABLED"
}
resource "aws_opensearch_serverlesscollection" "example" {
encryption_configs {
kms_key_arn = aws_kms_key.example.arn
}
name = "example"
type = "SEARCH"
collection_group_name = aws_opensearch_serverlesscollectiongroup.example.name
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kms.Key;
import com.pulumi.aws.kms.KeyArgs;
import com.pulumi.aws.opensearch.ServerlessCollectionGroup;
import com.pulumi.aws.opensearch.ServerlessCollectionGroupArgs;
import com.pulumi.aws.opensearch.ServerlessCollection;
import com.pulumi.aws.opensearch.ServerlessCollectionArgs;
import com.pulumi.aws.opensearch.inputs.ServerlessCollectionEncryptionConfigArgs;
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 Key("example", KeyArgs.builder()
.description("example")
.deletionWindowInDays(7)
.build());
var exampleServerlessCollectionGroup = new ServerlessCollectionGroup("exampleServerlessCollectionGroup", ServerlessCollectionGroupArgs.builder()
.name("example-group")
.standbyReplicas("ENABLED")
.build());
var exampleServerlessCollection = new ServerlessCollection("exampleServerlessCollection", ServerlessCollectionArgs.builder()
.encryptionConfigs(ServerlessCollectionEncryptionConfigArgs.builder()
.kmsKeyArn(example.arn())
.build())
.name("example")
.type("SEARCH")
.collectionGroupName(exampleServerlessCollectionGroup.name())
.build());
}
}
resources:
example:
type: aws:kms:Key
properties:
description: example
deletionWindowInDays: 7
exampleServerlessCollectionGroup:
type: aws:opensearch:ServerlessCollectionGroup
name: example
properties:
name: example-group
standbyReplicas: ENABLED
exampleServerlessCollection:
type: aws:opensearch:ServerlessCollection
name: example
properties:
encryptionConfigs:
- kmsKeyArn: ${example.arn}
name: example
type: SEARCH
collectionGroupName: ${exampleServerlessCollectionGroup.name}
Import
Identity Schema
Required
id(String) Unique identifier for the collection.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import OpenSearchServerless Collection using the id. For example:
$ pulumi import aws:opensearch/serverlessCollection:ServerlessCollection example example
Constructors
- ServerlessCollection(String name, {ServerlessCollectionArgs? args, CustomResourceOptions? options})
-
Creates a new ServerlessCollection.
nameThe Pulumi resource name.argsArguments used to configure this ServerlessCollection. The set of arguments for ServerlessCollection.optionsResource options controlling this resource's behavior. - ServerlessCollection.reference(String urn)
- Creates a typed reference to an existing ServerlessCollection resource.
Properties
-
arn
↔ Output<
String> -
ARN of the collection.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
collectionEndpoint
↔ Output<
String> -
Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
latefinal
-
collectionGroupName
↔ Output<
String?> -
Name of the collection group to associate with this collection.
latefinal
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
dashboardEndpoint
↔ Output<
String> -
Collection-specific endpoint used to access OpenSearch Dashboards.
latefinal
-
description
↔ Output<
String?> -
Description of the collection.
latefinal
-
encryptionConfigs
↔ Output<
List< ServerlessCollectionEncryptionConfig> > -
Configuration block for direct collection encryption settings. See
encryptionConfigbelow for details.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
-
kmsKeyArn
↔ Output<
String> -
ARN of the Amazon Web Services KMS key used to encrypt the collection.
latefinal
-
name
↔ Output<
String> -
Name of the collection.
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> -
Whether standby replicas should be used for a collection. One of
ENABLEDorDISABLED. Defaults toENABLED.latefinal -
Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
timeouts
↔ Output<
ServerlessCollectionTimeouts?> -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
type
↔ Output<
String> -
Type of collection. One of
SEARCH,TIMESERIES, orVECTORSEARCH. Defaults toTIMESERIES.latefinal -
urn
↔ Output<
String> -
latefinalinherited
-
vectorOptions
↔ Output<
List< ServerlessCollectionVectorOption> > -
Configuration block for vector search options. Only valid when
typeisVECTORSEARCH. SeevectorOptionsbelow for details.latefinal
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, {ServerlessCollectionState? state, CustomResourceOptions? options}) → ServerlessCollection -
Gets an existing ServerlessCollection resource's state with the given
nameandid.