SearchIndex

This class encapsulates and extends the ROS resource type ALIYUN::OTS::SearchIndex, which is used to create a search index for a data table.

You can create multiple search indexes for a data table.

Initializers

import ros_cdk_ots
ros_cdk_ots.SearchIndex(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No 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.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

field_schemas^Required

• 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

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

Property indexName: The index name.

---

instance_name^Required

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

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

---

table_name^Required

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

Property tableName: The table name of the OTS instance.

---

index_setting^Optional

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

Property indexSetting: Index settings.

---

index_sort^Optional

• 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.

---

enable_resource_property_constraint^Optional

• Type: bool

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	No description.

---

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

Name	Description
is_construct	Return whether the given object is a Construct.

---

is_construct

import ros_cdk_ots
ros_cdk_ots.SearchIndex.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.
attr_index_name	ros_cdk_core.IResolvable	Attribute IndexName: Index name.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---

attr_index_name^Required

attr_index_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute IndexName: Index name.

---