Package com.pulumi.aws.opensearch

Class ServerlessCollectionGroup

  • public class ServerlessCollectionGroup
extends com.pulumi.resources.CustomResource
    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 
     
 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());
 
     }
 }
    ## 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: ```sh $ pulumi import aws:opensearch/serverlessCollectionGroup:ServerlessCollectionGroup example example-group-id ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.List<ServerlessCollectionGroupCapacityLimit>> capacityLimits()  
      com.pulumi.core.Output<java.lang.String> createdDate()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.lang.String> generation()  
      static ServerlessCollectionGroup get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ServerlessCollectionGroupState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> standbyReplicas()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ServerlessCollectionGroup

        public ServerlessCollectionGroup​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • ServerlessCollectionGroup

        public ServerlessCollectionGroup​(java.lang.String name,
                                 ServerlessCollectionGroupArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • ServerlessCollectionGroup

        public ServerlessCollectionGroup​(java.lang.String name,
                                 ServerlessCollectionGroupArgs args,
                                 @Nullable
                                 com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the collection group.

      • capacityLimits

        public com.pulumi.core.Output<java.util.List<ServerlessCollectionGroupCapacityLimit>> capacityLimits()
        Returns:
        Configuration block for the collection group's indexing and search capacity limits. See `capacityLimits` below for details.

      • createdDate

        public com.pulumi.core.Output<java.lang.String> createdDate()
        Returns:
        Date the collection group was created.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description of the collection group.

      • generation

        public com.pulumi.core.Output<java.lang.String> generation()
        Returns:
        Generation of Amazon OpenSearch Serverless for the collection group. Valid values are `CLASSIC` and `NEXTGEN`. Default value is `CLASSIC`.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the collection group.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • standbyReplicas

        public com.pulumi.core.Output<java.lang.String> standbyReplicas()
        Returns:
        Indicates whether standby replicas should be used for collections in this group. Valid values are `ENABLED` and `DISABLED`. If `generation` is set to `NEXTGEN`, this argument must be set to `ENABLED`. The following arguments are optional:

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        A map of tags to assign to the collection group. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • get

        public static ServerlessCollectionGroup get​(java.lang.String name,
                                            com.pulumi.core.Output<java.lang.String> id,
                                            @Nullable
                                            ServerlessCollectionGroupState state,
                                            @Nullable
                                            com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.