# CfnCollectionProps

Properties for defining a `CfnCollection`.

Extends: CfnCollectionProps
Used as props by: CfnCollection

- Source: Generated code
- Type last changed: v2.260.0 · 16 Jun 2026

## Example

```ts
// 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
  collectionGroupName: 'collectionGroupName',
  deletionProtection: 'deletionProtection',
  description: 'description',
  encryptionConfig: {
    awsOwnedKey: false,
    kmsKeyArn: 'kmsKeyArn',
  },
  standbyReplicas: 'standbyReplicas',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  type: 'type',
  vectorOptions: {
    serverlessVectorAcceleration: 'serverlessVectorAcceleration',
  },
};
```

## Properties

- `collectionGroupName`: string — The name of the collection group to associate with the collection.

- `deletionProtection`: string — The deletion protection state of the collection.

- `description`: string — A description of the collection.

- `encryptionConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCollection.EncryptionConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_opensearchserverless.CfnCollection.EncryptionConfigProperty.html) — Encryption settings for the collection.

- `name`: string (required) — 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 (-)

- `standbyReplicas`: string — Indicates whether to use standby replicas for the collection.

  You can't update this property after the collection is already created. If you attempt to modify this property, the collection continues to use the original value.

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — An arbitrary set of tags (key–value pairs) to associate with the collection.

  For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

- `type`: string — The type of collection.

  Possible values are `SEARCH` , `TIMESERIES` , and `VECTORSEARCH` . For more information, see [Choosing a collection type](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html#serverless-usecase) .

- `vectorOptions`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCollection.VectorOptionsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_opensearchserverless.CfnCollection.VectorOptionsProperty.html) — Vector search configuration options for the collection.