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 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();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
instanceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceName: The name of the OTS instance in which table will locate.
primaryKey com.aliyun.ros.cdk.core.IResolvable OR java.util.ListPrimaryKeyProperty> Property primaryKey: It describes the attribute value of primary key.
tableName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property tableName: The table name of the OTS instance.
columns com.aliyun.ros.cdk.core.IResolvable OR java.util.ListColumnsProperty> Property columns: Attribute column for table store.
deviationCellVersionInSec java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property deviationCellVersionInSec: Maximum version deviation.
maxVersions java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property maxVersions: The maximum number of versions stored in this table.
reservedThroughput 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 com.aliyun.ros.cdk.core.IResolvable OR java.util.ListSecondaryIndicesProperty> Property secondaryIndices: The secondary indices of the table.
timeToLive java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property timeToLive: The retention time of data stored in this table (unit: second).

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

instanceNameRequired

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

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

primaryKeyRequired

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

tableNameRequired

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

Property tableName: The table name of the OTS instance.

columnsOptional

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

Property columns: Attribute column for table store.

deviationCellVersionInSecOptional

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

maxVersionsOptional

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

reservedThroughputOptional

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.

secondaryIndicesOptional

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

Property secondaryIndices: The secondary indices of the table.

timeToLiveOptional

  • 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

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

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.

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

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

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

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

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrTableName com.aliyun.ros.cdk.core.IResolvable Attribute TableName: Table name.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrTableNameRequired 

public IResolvable getAttrTableName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute TableName: Table name.