interface CfnCollectionMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.OpenSearchServerless.Mixins.CfnCollectionMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsopensearchserverless/mixins#CfnCollectionMixinProps
Java	software.amazon.awscdk.mixins.preview.services.opensearchserverless.mixins.CfnCollectionMixinProps
Python	aws_cdk.mixins_preview.aws_opensearchserverless.mixins.CfnCollectionMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_opensearchserverless » mixins » CfnCollectionMixinProps

Properties for CfnCollectionPropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as opensearchserverless_mixins } from '@aws-cdk/mixins-preview/aws-opensearchserverless';
const cfnCollectionMixinProps: opensearchserverless_mixins.CfnCollectionMixinProps = {
  description: 'description',
  name: 'name',
  standbyReplicas: 'standbyReplicas',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  type: 'type',
};

Properties

Name	Type	Description
description?	string	A description of the collection.
name?	string	The name of the collection.
standbyReplicas?	string	Indicates whether to use standby replicas for the collection.
tags?	CfnTag[]	An arbitrary set of tags (key–value pairs) to associate with the collection.
type?	string	The type of collection.

---

description?

Type: string (optional)

A description of the collection.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-description

---

name?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-name

---

standbyReplicas?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-standbyreplicas

---

tags?

Type: CfnTag[] (optional)

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

For more information, see Tag .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-tags

---

type?

Type: string (optional)

The type of collection.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-type