interface PropertyMappingProperty
| Language | Type name |
|---|---|
.NET | Amazon.CDK.Mixins.Preview.AWS.OpenSearchServerless.Mixins.CfnIndexPropsMixin.PropertyMappingProperty |
Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsopensearchserverless/mixins#CfnIndexPropsMixin_PropertyMappingProperty |
Java | software.amazon.awscdk.mixins.preview.services.opensearchserverless.mixins.CfnIndexPropsMixin.PropertyMappingProperty |
Python | aws_cdk.mixins_preview.aws_opensearchserverless.mixins.CfnIndexPropsMixin.PropertyMappingProperty |
TypeScript | @aws-cdk/mixins-preview » aws_opensearchserverless » mixins » CfnIndexPropsMixin » PropertyMappingProperty |
Property mappings for the OpenSearch Serverless index.
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';
declare const propertyMappingProperty_: opensearchserverless_mixins.CfnIndexPropsMixin.PropertyMappingProperty;
const propertyMappingProperty: opensearchserverless_mixins.CfnIndexPropsMixin.PropertyMappingProperty = {
dimension: 123,
index: false,
method: {
engine: 'engine',
name: 'name',
parameters: {
efConstruction: 123,
m: 123,
},
spaceType: 'spaceType',
},
properties: {
propertiesKey: propertyMappingProperty_,
},
type: 'type',
value: 'value',
};
Properties
| Name | Type | Description |
|---|---|---|
| dimension? | number | Dimension size for vector fields, defines the number of dimensions in the vector. |
| index? | boolean | IResolvable | Whether a field should be indexed. |
| method? | IResolvable | Method | Configuration for k-NN search method. |
| properties? | IResolvable | { [string]: IResolvable | Property } | Defines the fields within the mapping, including their types and configurations. |
| type? | string | The field data type. |
| value? | string | Default value for the field when not specified in a document. |
dimension?
Type:
number
(optional)
Dimension size for vector fields, defines the number of dimensions in the vector.
index?
Type:
boolean | IResolvable
(optional)
Whether a field should be indexed.
method?
Type:
IResolvable | Method
(optional)
Configuration for k-NN search method.
properties?
Type:
IResolvable | { [string]: IResolvable | Property }
(optional)
Defines the fields within the mapping, including their types and configurations.
type?
Type:
string
(optional)
The field data type.
Must be a valid OpenSearch field type.
value?
Type:
string
(optional)
Default value for the field when not specified in a document.

.NET
Go
Java
Python
TypeScript