Modifier and Type | Method and Description |
---|---|
CfnTable |
build() |
static CfnTable.Builder |
create(Construct scope,
java.lang.String id) |
CfnTable.Builder |
databaseName(java.lang.String databaseName)
The name of the Timestream database that contains this table.
|
CfnTable.Builder |
magneticStoreWriteProperties(java.lang.Object magneticStoreWriteProperties)
Contains properties to set on the table when enabling magnetic store writes.
|
CfnTable.Builder |
retentionProperties(java.lang.Object retentionProperties)
The retention duration for the memory store and magnetic store.
|
CfnTable.Builder |
tableName(java.lang.String tableName)
The name of the Timestream table.
|
CfnTable.Builder |
tags(java.util.List<? extends CfnTag> tags)
The tags to add to the table.
|
public static CfnTable.Builder create(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.CfnTable.Builder
.public CfnTable.Builder databaseName(java.lang.String databaseName)
Length Constraints : Minimum length of 3 bytes. Maximum length of 256 bytes.
databaseName
- The name of the Timestream database that contains this table. This parameter is required.this
public CfnTable.Builder magneticStoreWriteProperties(java.lang.Object magneticStoreWriteProperties)
This object has the following attributes:
boolean
flag to enable magnetic store writes.S3Configuration
objects are allowed. The S3Configuration
object has the following attributes:SSE_S3
) or AWS managed key ( SSE_KMS
).
Both BucketName
and EncryptionOption
are required when S3Configuration
is specified. If you specify SSE_KMS
as your EncryptionOption
then KmsKeyId
is required .
EnableMagneticStoreWrites
attribute is required when MagneticStoreWriteProperties
is specified. MagneticStoreRejectedDataLocation
attribute is required when EnableMagneticStoreWrites
is set to true
.
See the following examples:
JSON
{ "Type" : AWS::Timestream::Table", "Properties":{ "DatabaseName":"TestDatabase", "TableName":"TestTable", "MagneticStoreWriteProperties":{ "EnableMagneticStoreWrites":true, "MagneticStoreRejectedDataLocation":{ "S3Configuration":{ "BucketName":"testbucket", "EncryptionOption":"SSE_KMS", "KmsKeyId":"1234abcd-12ab-34cd-56ef-1234567890ab", "ObjectKeyPrefix":"prefix" } } } } }
YAML
Type: AWS::Timestream::Table DependsOn: TestDatabase Properties: TableName: "TestTable" DatabaseName: "TestDatabase" MagneticStoreWriteProperties: EnableMagneticStoreWrites: true MagneticStoreRejectedDataLocation: S3Configuration: BucketName: "testbucket" EncryptionOption: "SSE_KMS" BucketName: "1234abcd-12ab-34cd-56ef-1234567890ab" EncryptionOption: "prefix"
magneticStoreWriteProperties
- Contains properties to set on the table when enabling magnetic store writes. This parameter is required.this
public CfnTable.Builder retentionProperties(java.lang.Object retentionProperties)
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"
retentionProperties
- The retention duration for the memory store and magnetic store. This object has the following attributes:. This parameter is required.this
public CfnTable.Builder tableName(java.lang.String tableName)
Length Constraints : Minimum length of 3 bytes. Maximum length of 256 bytes.
tableName
- The name of the Timestream table. This parameter is required.this
public CfnTable.Builder tags(java.util.List<? extends CfnTag> tags)
tags
- The tags to add to the table. This parameter is required.this
public CfnTable build()