SearchIndex

• Implements: ISearchIndex

This class encapsulates and extends the ROS resource type ALIYUN::OTS::SearchIndex.

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
)

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

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

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

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

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

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

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: typing.Union[str, IResolvable]

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

Attribute IndexName: Index name.

props^Required

props: SearchIndexProps

• Type: SearchIndexProps