Package software.amazon.awscdk.services.opensearchserverless

Class CfnCollection

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.opensearchserverless.CfnCollection
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggable, ICollectionRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:10.480Z") @Stability(Stable) public class CfnCollection extends CfnResource implements IInspectable, ICollectionRef, ITaggable
Specifies an OpenSearch Serverless collection.

For more information, see Creating and managing Amazon OpenSearch Serverless collections in the Amazon OpenSearch Service Developer Guide .

You must create a matching encryption policy in order for a collection to be created successfully. You can specify the policy resource within the same CloudFormation template as the collection resource if you use the DependsOn attribute. See Examples for a sample template. Otherwise the encryption policy must already exist before you create the collection.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.opensearchserverless.*;
 CfnCollection cfnCollection = CfnCollection.Builder.create(this, "MyCfnCollection")
         .name("name")
         // the properties below are optional
         .description("description")
         .standbyReplicas("standbyReplicas")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .type("type")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCollection

      protected CfnCollection(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCollection

      protected CfnCollection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCollection

      @Stability(Stable) public CfnCollection(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCollectionProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromCollectionArn

      @Stability(Stable) @NotNull public static ICollectionRef fromCollectionArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new ICollectionRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromCollectionId

      @Stability(Stable) @NotNull public static ICollectionRef fromCollectionId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String collectionId)
      Creates a new ICollectionRef from a collectionId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      collectionId - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the collection.

      For example, arn:aws:aoss:us-east-1:123456789012:collection/07tjusf2h91cunochc .

    • getAttrCollectionEndpoint

      @Stability(Stable) @NotNull public String getAttrCollectionEndpoint()
      Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.

      For example, https://07tjusf2h91cunochc.us-east-1.aoss.amazonaws.com .

    • getAttrDashboardEndpoint

      @Stability(Stable) @NotNull public String getAttrDashboardEndpoint()
      The collection-specific endpoint used to access OpenSearch Dashboards.

      For example, https://07tjusf2h91cunochc.us-east-1.aoss.amazonaws.com/_dashboards .

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      A unique identifier for the collection.

      For example, 07tjusf2h91cunochc .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCollectionRef

      @Stability(Stable) @NotNull public CollectionReference getCollectionRef()
      A reference to a Collection resource.
      Specified by:
      getCollectionRef in interface ICollectionRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the collection.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the collection.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the collection.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the collection.

    • getStandbyReplicas

      @Stability(Stable) @Nullable public String getStandbyReplicas()
      Indicates whether to use standby replicas for the collection.

    • setStandbyReplicas

      @Stability(Stable) public void setStandbyReplicas(@Nullable String value)
      Indicates whether to use standby replicas for the collection.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An arbitrary set of tags (key–value pairs) to associate with the collection.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An arbitrary set of tags (key–value pairs) to associate with the collection.

    • getType

      @Stability(Stable) @Nullable public String getType()
      The type of collection.

    • setType

      @Stability(Stable) public void setType(@Nullable String value)
      The type of collection.