Table

• Implements: ITable

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

Initializers

import com.aliyun.ros.cdk.ots.Table;
Table.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .instanceName(java.lang.String)
    .instanceName(IResolvable)
    .primaryKey(IResolvable)
    .primaryKey(java.util.List<IResolvable)
    .primaryKey(PrimaryKeyProperty>)
    .tableName(java.lang.String)
    .tableName(IResolvable)
//  .columns(IResolvable)
//  .columns(java.util.List<IResolvable)
//  .columns(ColumnsProperty>)
//  .deviationCellVersionInSec(java.lang.Number)
//  .deviationCellVersionInSec(IResolvable)
//  .maxVersions(java.lang.Number)
//  .maxVersions(IResolvable)
//  .reservedThroughput(IResolvable)
//  .reservedThroughput(ReservedThroughputProperty)
//  .secondaryIndices(IResolvable)
//  .secondaryIndices(java.util.List<IResolvable)
//  .secondaryIndices(SecondaryIndicesProperty>)
//  .timeToLive(java.lang.Number)
//  .timeToLive(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

instanceName^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

primaryKey^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListPrimaryKeyProperty>

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.

tableName^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property tableName: The table name of the OTS instance.

columns^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListColumnsProperty>

Property columns: Attribute column for table store.

deviationCellVersionInSec^Optional

• Type: java.lang.Number OR com.aliyun.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.

maxVersions^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

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

reservedThroughput^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR 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.

secondaryIndices^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListSecondaryIndicesProperty>

Property secondaryIndices: The secondary indices of the table.

timeToLive^Optional

• Type: java.lang.Number OR com.aliyun.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.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.ots.Table;
Table.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrTableName^Required

public java.lang.Object getAttrTableName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute TableName: Table name.

props^Required

public TableProps getProps();

• Type: TableProps