pulumi-aws-kotlin/com.pulumi.aws.opensearch.kotlin/ServerlessCollection

ServerlessCollection

class ServerlessCollection : KotlinCustomResource

Resource for managing an AWS OpenSearch Serverless Collection.

NOTE: An aws.opensearch.ServerlessCollection cannot be created without having an applicable encryption security policy. Use the depends_on meta-argument to define this dependency. 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

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.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) {
        var exampleServerlessSecurityPolicy = new ServerlessSecurityPolicy("exampleServerlessSecurityPolicy", ServerlessSecurityPolicyArgs.builder()
            .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.Empty, CustomResourceOptions.builder()
            .dependsOn(exampleServerlessSecurityPolicy)
            .build());
    }
}

Import

Using pulumi import, import OpenSearchServerless Collection using the id. For example:

$ pulumi import aws:opensearch/serverlessCollection:ServerlessCollection example example

Properties

arn

val arn: Output<String>

Amazon Resource Name (ARN) of the collection.

collectionEndpoint

val collectionEndpoint: Output<String>

Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.

dashboardEndpoint

val dashboardEndpoint: Output<String>

Collection-specific endpoint used to access OpenSearch Dashboards.

description

val description: Output<String>?

Description of the collection.

val id: Output<String>

kmsKeyArn

val kmsKeyArn: Output<String>

The ARN of the Amazon Web Services KMS key used to encrypt the collection.

name

val name: Output<String>

Name of the collection. The following arguments are optional:

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String