Package software.amazon.awscdk.services.opensearchserverless

Class CfnCollection

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.opensearchserverless.CfnCollection
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.553Z") @Stability(Stable) public class CfnCollection extends CfnResource implements IInspectable
A CloudFormation AWS::OpenSearchServerless::Collection.

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")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .type("type")
         .build();

  • 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 Construct scope, @NotNull String id, @NotNull CfnCollectionProps props)
      Create a new AWS::OpenSearchServerless::Collection.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • 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()
      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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An arbitrary set of tags (key–value pairs) to associate with the collection.

      For more information, see Tag .

    • getName

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

      Collection names must meet the following criteria:

      • Starts with a lowercase letter
      • Unique to your account and AWS Region
      • Contains between 3 and 28 characters
      • Contains only lowercase letters a-z, the numbers 0-9, and the hyphen (-)

    • setName

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

      Collection names must meet the following criteria:

      • Starts with a lowercase letter
      • Unique to your account and AWS Region
      • Contains between 3 and 28 characters
      • Contains only lowercase letters a-z, the numbers 0-9, and the hyphen (-)

    • 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.

    • getType

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

      Possible values are SEARCH and TIMESERIES . For more information, see Choosing a collection type .

    • setType

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

      Possible values are SEARCH and TIMESERIES . For more information, see Choosing a collection type .