SearchIndexProps

Properties for defining a SearchIndex.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ots-searchindex

Initializer

import ros_cdk_ots
ros_cdk_ots.SearchIndexProps(
  field_schemas: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, FieldSchemasProperty]]],
  index_name: typing.Union[str, IResolvable],
  instance_name: typing.Union[str, IResolvable],
  table_name: typing.Union[str, IResolvable],
  index_setting: typing.Union[IResolvable, IndexSettingProperty] = None,
  index_sort: typing.Union[IResolvable, IndexSortProperty] = None
)

Properties

Name	Type	Description
field_schemas	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, FieldSchemasProperty]]]	Property fieldSchemas: list of field_schema.
index_name	typing.Union[str, ros_cdk_core.IResolvable]	Property indexName: The index name.
instance_name	typing.Union[str, ros_cdk_core.IResolvable]	Property instanceName: The name of the OTS instance in which table will locate.
table_name	typing.Union[str, ros_cdk_core.IResolvable]	Property tableName: The table name of the OTS instance.
index_setting	typing.Union[ros_cdk_core.IResolvable, IndexSettingProperty]	Property indexSetting: Index settings.
index_sort	typing.Union[ros_cdk_core.IResolvable, IndexSortProperty]	Property indexSort: This parameter specifies how data is sorted.

---

field_schemas^Required

field_schemas: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, FieldSchemasProperty]]]

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, FieldSchemasProperty]]]

Property fieldSchemas: list of field_schema.

---

index_name^Required

index_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property indexName: The index name.

---

instance_name^Required

instance_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property instanceName: The name of the OTS instance in which table will locate.

---

table_name^Required

table_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property tableName: The table name of the OTS instance.

---

index_setting^Optional

index_setting: typing.Union[IResolvable, IndexSettingProperty]

• Type: typing.Union[ros_cdk_core.IResolvable, IndexSettingProperty]

Property indexSetting: Index settings.

---

index_sort^Optional

index_sort: typing.Union[IResolvable, IndexSortProperty]

• Type: typing.Union[ros_cdk_core.IResolvable, IndexSortProperty]

Property indexSort: This parameter specifies how data is sorted.

By default, the data is sorted in the same way as the primary key of the table. If the search index contains NESTED fields, data is not sorted by default.

---