Skip to content

TableProps

Properties for defining a Table.

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

Initializer 

import ros_cdk_ots
ros_cdk_ots.TableProps(
  instance_name: typing.Union[str, IResolvable],
  primary_key: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, PrimaryKeyProperty]]],
  table_name: typing.Union[str, IResolvable],
  columns: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ColumnsProperty]]] = None,
  deviation_cell_version_in_sec: typing.Union[typing.Union[int, float], IResolvable] = None,
  max_versions: typing.Union[typing.Union[int, float], IResolvable] = None,
  reserved_throughput: typing.Union[IResolvable, ReservedThroughputProperty] = None,
  secondary_indices: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, SecondaryIndicesProperty]]] = None,
  time_to_live: typing.Union[typing.Union[int, float], IResolvable] = None
)

Properties

Name Type Description
instance_name typing.Union[str, ros_cdk_core.IResolvable] Property instanceName: The name of the OTS instance in which table will locate.
primary_key typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, PrimaryKeyProperty]]] Property primaryKey: It describes the attribute value of primary key.
table_name typing.Union[str, ros_cdk_core.IResolvable] Property tableName: The table name of the OTS instance.
columns typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ColumnsProperty]]] Property columns: Attribute column for table store.
deviation_cell_version_in_sec typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property deviationCellVersionInSec: Maximum version deviation.
max_versions typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property maxVersions: The maximum number of versions stored in this table.
reserved_throughput typing.Union[ros_cdk_core.IResolvable, ReservedThroughputProperty] Property reservedThroughput: The initial reserved read\/write throughput setting of the table to be created, the reserved read throughput and reserved write throughput of any table cannot exceed 5000.
secondary_indices typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, SecondaryIndicesProperty]]] Property secondaryIndices: The secondary indices of the table.
time_to_live typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property timeToLive: The retention time of data stored in this table (unit: second).

instance_nameRequired 

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.

primary_keyRequired 

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

Property primaryKey: It describes the attribute value of primary key.

The number of primary_key should not be less than one and not be more than four.

table_nameRequired 

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

Property tableName: The table name of the OTS instance.

columnsOptional 

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

Property columns: Attribute column for table store.

deviation_cell_version_in_secOptional 

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

Property deviationCellVersionInSec: Maximum version deviation.

The purpose is mainly to prohibit writing and expected large data, such as setting the deviation_cell_version_in_sec to 1000, and if the current timestamp is 10000, the timestamp range allowed to be written is [10000 - 1000, 10000 + 1000]. The valid value is 1-9223372036854775807. Defaults to 86400.

max_versionsOptional 

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

Property maxVersions: The maximum number of versions stored in this table.

The valid value is 1-2147483647. Default to 1.

reserved_throughputOptional 

reserved_throughput: typing.Union[IResolvable, ReservedThroughputProperty]

Property reservedThroughput: The initial reserved read\/write throughput setting of the table to be created, the reserved read throughput and reserved write throughput of any table cannot exceed 5000.

secondary_indicesOptional 

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

Property secondaryIndices: The secondary indices of the table.

time_to_liveOptional 

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

Property timeToLive: The retention time of data stored in this table (unit: second).

The value maximum is 2147483647 and -1 means never expired. Default to -1.