aws-cdk-lib.aws_opensearchserverless.CfnCollectionProps

interface CfnCollectionProps

LanguageType name
.NETAmazon.CDK.AWS.OpenSearchServerless.CfnCollectionProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsopensearchserverless#CfnCollectionProps
Javasoftware.amazon.awscdk.services.opensearchserverless.CfnCollectionProps
Pythonaws_cdk.aws_opensearchserverless.CfnCollectionProps
TypeScript aws-cdk-lib » aws_opensearchserverless » CfnCollectionProps

Properties for defining a CfnCollection.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_opensearchserverless as opensearchserverless } from 'aws-cdk-lib';
const cfnCollectionProps: opensearchserverless.CfnCollectionProps = {
  name: 'name',

  // the properties below are optional
  description: 'description',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  type: 'type',
};

Properties

NameTypeDescription
namestringThe name of the collection.
description?stringA description of the collection.
tags?CfnTag[]An arbitrary set of tags (key–value pairs) to associate with the collection.
type?stringThe type of collection.

name

Type: string

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

description?

Type: string (optional)

A description of the collection.


tags?

Type: CfnTag[] (optional)

An arbitrary set of tags (key–value pairs) to associate with the collection.

For more information, see Tag .


type?

Type: string (optional)

The type of collection.

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