# CfnTableProps

Properties for defining a `CfnTable`.

Extends: CfnTableProps
Used as props by: CfnTable

- Source: Generated code
- Type last changed: v2.227.0 · 21 Nov 2025

## Example

```ts
// 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,
  schema: {
    compositePartitionKey: [{
      type: 'type',

      // the properties below are optional
      enforcementInRecord: 'enforcementInRecord',
      name: 'name',
    }],
  },
  tableName: 'tableName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
```

## Properties

- `databaseName`: string | [IDatabaseRef](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_timestream.IDatabaseRef.html) (required) — The name of the Timestream database that contains this table.

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

- `magneticStoreWriteProperties`: any — 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*

  ```json
  { "Type" : AWS::Timestream::Table", "Properties":{ "DatabaseName":"TestDatabase", "TableName":"TestTable", "MagneticStoreWriteProperties":{ "EnableMagneticStoreWrites":true, "MagneticStoreRejectedDataLocation":{ "S3Configuration":{ "BucketName":" amzn-s3-demo-bucket ", "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: " amzn-s3-demo-bucket " EncryptionOption: "SSE_KMS" KmsKeyId: "1234abcd-12ab-34cd-56ef-1234567890ab" ObjectKeyPrefix: "prefix"
  ```

- `retentionProperties`: any — 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"
  ```

- `schema`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnTable.SchemaProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_timestream.CfnTable.SchemaProperty.html) — The schema of the table.

- `tableName`: string — The name of the Timestream table.

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

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — The tags to add to the table.