Skip to content
v2.274.0

CfnCollectionGroupProps Struct ​

Properties for defining a CfnCollectionGroup.

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 cfnCollectionGroupProps: opensearchserverless.CfnCollectionGroupProps = {
  name: 'name',
  standbyReplicas: 'standbyReplicas',

  // the properties below are optional
  capacityLimits: {
    maxIndexingCapacityInOcu: 123,
    maxSearchCapacityInOcu: 123,
    minIndexingCapacityInOcu: 123,
    minSearchCapacityInOcu: 123,
  },
  description: 'description',
  generation: 'generation',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

capacityLimitsoptionalIResolvable | CfnCollectionGroup.CapacityLimitsPropertycapacity_limitsoptionaltyping.Union[IResolvable, CapacityLimitsProperty]capacityLimitsoptionalIResolvableCapacityLimitsoptionalIResolvableCapacityLimitsoptionalinterface{}#
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description of the collection group.
generationoptionalstringgenerationoptionalstrgenerationoptionalStringGenerationoptionalstringGenerationoptional*string#
The generation of Amazon OpenSearch Serverless for the collection group.

Valid values are CLASSIC and NEXTGEN.

namestringnamestrnameStringNamestringName*stringrequired#
The name of the collection group.
standbyReplicasstringstandby_replicasstrstandbyReplicasStringStandbyReplicasstringStandbyReplicas*stringrequired#
Indicates whether standby replicas are used for the collection group.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
An array of key-value pairs to apply to this resource.