This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).
# AWS::Timestream::Table
The CreateTable operation adds a new table to an existing database in your account. In an AWS account, table names must be at least unique within each Region if they are in the same database. You may have identical table names in the same Region if the tables are in separate databases. While creating the table, you must specify the table name, database name, and the retention properties. [Service quotas apply](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-table.html) for details.
## Syntax
To declare this entity in your CloudFormation template, use the following syntax:
### JSON
```
{
"Type" : "AWS::Timestream::Table",
"Properties" : {
"[DatabaseName](#cfn-timestream-table-databasename)" : String,
"[MagneticStoreWriteProperties](#cfn-timestream-table-magneticstorewriteproperties)" : MagneticStoreWriteProperties,
"[RetentionProperties](#cfn-timestream-table-retentionproperties)" : RetentionProperties,
"[Schema](#cfn-timestream-table-schema)" : Schema,
"[TableName](#cfn-timestream-table-tablename)" : String,
"[Tags](#cfn-timestream-table-tags)" : [ Tag, ... ]
}
}
```
### YAML
```
Type: AWS::Timestream::Table
Properties:
[DatabaseName](#cfn-timestream-table-databasename): String
[MagneticStoreWriteProperties](#cfn-timestream-table-magneticstorewriteproperties):
MagneticStoreWriteProperties
[RetentionProperties](#cfn-timestream-table-retentionproperties):
RetentionProperties
[Schema](#cfn-timestream-table-schema):
Schema
[TableName](#cfn-timestream-table-tablename): String
[Tags](#cfn-timestream-table-tags):
- Tag
```
## Properties
`DatabaseName`
The name of the Timestream database that contains this table.
*Length Constraints*: Minimum length of 3 bytes. Maximum length of 256 bytes.
*Required*: Yes
*Type*: String
*Pattern*: `^[a-zA-Z0-9_.-]{3,256}$`
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)
`MagneticStoreWriteProperties`
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":"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"
```
*Required*: No
*Type*: [MagneticStoreWriteProperties](aws-properties-timestream-table-magneticstorewriteproperties.md)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`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"
```
*Required*: No
*Type*: [RetentionProperties](aws-properties-timestream-table-retentionproperties.md)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`Schema`
The schema of the table.
*Required*: No
*Type*: [Schema](aws-properties-timestream-table-schema.md)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`TableName`
The name of the Timestream table.
*Length Constraints*: Minimum length of 3 bytes. Maximum length of 256 bytes.
*Required*: No
*Type*: String
*Pattern*: `^[a-zA-Z0-9_.-]{3,256}$`
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)
`Tags`
The tags to add to the table
*Required*: No
*Type*: Array of [Tag](aws-properties-timestream-table-tag.md)
*Maximum*: `200`
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
## Return values
### Ref
When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the table name `TABLE_NAME` in the form `DATABASE_NAME|TABLE_NAME`. `DATABASE_NAME` is the name of the Timestream database that the table is contained in.
For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).
### Fn::GetAtt
The `Fn::GetAtt` returns a value for the specified attribute of this type. The following are the available attributes:
####
`Arn`
The `arn` of the table.
`Name`
The name of the table.