software.amazon.awscdk.services.timestream

Class CfnTable.Builder

java.lang.Object

software.amazon.awscdk.services.timestream.CfnTable.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTable>

Enclosing class:

CfnTable

@Stability(value=Stable)
public static final class CfnTable.Builder
extends Object
implements software.amazon.jsii.Builder<CfnTable>

A fluent builder for CfnTable.

Method Summary

Modifier and Type	Method and Description
CfnTable	build()
static CfnTable.Builder	create(Construct scope, String id)
CfnTable.Builder	databaseName(String databaseName) The name of the Timestream database that contains this table.
CfnTable.Builder	retentionProperties(Object retentionProperties) The retention duration for the memory store and magnetic store.
CfnTable.Builder	tableName(String tableName) The name of the Timestream table.
CfnTable.Builder	tags(List<? extends CfnTag> tags) The tags to add to the table.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static CfnTable.Builder create(Construct scope,
                                                               String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnTable.Builder.

databaseName

@Stability(value=Stable)
public CfnTable.Builder databaseName(String databaseName)

The name of the Timestream database that contains this table.

Length Constraints : Minimum length of 3 bytes. Maximum length of 256 bytes.

Parameters:

databaseName - The name of the Timestream database that contains this table. This parameter is required.

Returns:

this

retentionProperties

@Stability(value=Stable)
public CfnTable.Builder retentionProperties(Object retentionProperties)

The retention duration for the memory store and magnetic store. This object has the following attributes:.

• MemoryStoreRetentionPeriodInHours : Retention duration for memory store, in hours.
• MagneticStoreRetentionPeriodInDays : Retention duration for magnetic store, in days.

Both attributes are of type string . Both attributes are required when RetentionProperties is specified.

See the following examples:

JSON

{ "Type" : AWS::Timestream::Table", "Properties" : { "DatabaseName" : "TestDatabase", "TableName" : "TestTable", "RetentionProperties" : { "MemoryStoreRetentionPeriodInHours": "24", "MagneticStoreRetentionPeriodInDays": "7" } } }

YAML

 Type: AWS::Timestream::Table
 DependsOn: TestDatabase
 Properties: TableName: "TestTable" DatabaseName: "TestDatabase" RetentionProperties: MemoryStoreRetentionPeriodInHours: "24" MagneticStoreRetentionPeriodInDays: "7"
 

Parameters:

retentionProperties - The retention duration for the memory store and magnetic store. This object has the following attributes:. This parameter is required.

Returns:

this

tableName

@Stability(value=Stable)
public CfnTable.Builder tableName(String tableName)

The name of the Timestream table.

Length Constraints : Minimum length of 3 bytes. Maximum length of 256 bytes.

Parameters:

tableName - The name of the Timestream table. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnTable.Builder tags(List<? extends CfnTag> tags)

The tags to add to the table.

Parameters:

tags - The tags to add to the table. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnTable build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnTable>