aws-cdk-lib.aws_timestream.CfnTableProps

interface CfnTableProps

LanguageType name
.NETAmazon.CDK.AWS.Timestream.CfnTableProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awstimestream#CfnTableProps
Javasoftware.amazon.awscdk.services.timestream.CfnTableProps
Pythonaws_cdk.aws_timestream.CfnTableProps
TypeScript aws-cdk-lib » aws_timestream » CfnTableProps

Properties for defining a CfnTable.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_timestream as timestream } from 'aws-cdk-lib';

declare const magneticStoreWriteProperties: any;
declare const retentionProperties: any;
const cfnTableProps: timestream.CfnTableProps = {
  databaseName: 'databaseName',

  // the properties below are optional
  magneticStoreWriteProperties: magneticStoreWriteProperties,
  retentionProperties: retentionProperties,
  tableName: 'tableName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
databaseNamestringThe name of the Timestream database that contains this table.
magneticStoreWriteProperties?anyContains properties to set on the table when enabling magnetic store writes.
retentionProperties?anyThe retention duration for the memory store and magnetic store. This object has the following attributes:.
tableName?stringThe name of the Timestream table.
tags?CfnTag[]The tags to add to the table.

databaseName

Type: string

The name of the Timestream database that contains this table.

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


magneticStoreWriteProperties?

Type: any (optional)

Contains properties to set on the table when enabling magnetic store writes.

This object has the following attributes:

  • EnableMagneticStoreWrites : A boolean flag to enable magnetic store writes.

  • MagneticStoreRejectedDataLocation : The location to write error reports for records rejected, asynchronously, during magnetic store writes. Only S3Configuration objects are allowed. The S3Configuration object has the following attributes:

  • BucketName : The name of the S3 bucket.

  • EncryptionOption : The encryption option for the S3 location. Valid values are S3 server-side encryption with an S3 managed key ( SSE_S3 ) or AWS managed key ( SSE_KMS ).

  • KmsKeyId : The AWS KMS key ID to use when encrypting with an AWS managed key.

  • ObjectKeyPrefix : The prefix to use option for the objects stored in S3.

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" KmsKeyId: "1234abcd-12ab-34cd-56ef-1234567890ab" ObjectKeyPrefix: "prefix"

retentionProperties?

Type: any (optional)

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"

tableName?

Type: string (optional)

The name of the Timestream table.

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


tags?

Type: CfnTag[] (optional)

The tags to add to the table.