Skip to content

Table

This class encapsulates and extends the ROS resource type ALIYUN::OTS::Table, which is used to create a table based on a specified schema.

Initializers 

import ros_cdk_ots
ros_cdk_ots.Table(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No 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).
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

instance_nameRequired

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

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

primary_keyRequired

  • 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

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

Property tableName: The table name of the OTS instance.

columnsOptional

  • 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

  • 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

  • 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

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

  • 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

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

enable_resource_property_constraintOptional

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

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

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

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • 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.Table.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • 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_table_name ros_cdk_core.IResolvable Attribute TableName: Table name.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_table_nameRequired 

attr_table_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute TableName: Table name.