class CfnIndexPropsMixin (mixin)

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.OpenSearchServerless.CfnIndexPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsopensearchserverless#CfnIndexPropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.opensearchserverless.CfnIndexPropsMixin
Python	aws_cdk.cfn_property_mixins.aws_opensearchserverless.CfnIndexPropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_opensearchserverless » CfnIndexPropsMixin

Implements IMixin

Extends Mixin

An OpenSearch Serverless index resource.

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

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/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
declare const propertyMappingProperty_: opensearchserverless.CfnIndexPropsMixin.PropertyMappingProperty;
const cfnIndexPropsMixin = new opensearchserverless.CfnIndexPropsMixin({
  collectionEndpoint: 'collectionEndpoint',
  indexName: 'indexName',
  mappings: {
    properties: {
      propertiesKey: {
        dimension: 123,
        index: false,
        method: {
          engine: 'engine',
          name: 'name',
          parameters: {
            efConstruction: 123,
            m: 123,
          },
          spaceType: 'spaceType',
        },
        properties: {
          propertiesKey: propertyMappingProperty_,
        },
        type: 'type',
        value: 'value',
      },
    },
  },
  settings: {
    index: {
      knn: false,
      knnAlgoParamEfSearch: 123,
      refreshInterval: 'refreshInterval',
    },
  },
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnIndexPropsMixin(props: CfnIndexMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnIndexMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::OpenSearchServerless::Index.

Properties

Name	Type	Description
props	CfnIndexMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnIndexMixinProps

---

strategy

Type: IMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.