published on Monday, Nov 2, 2026 by Pulumi
published on Monday, Nov 2, 2026 by Pulumi
Provides a Timestream table resource.
Example Usage
Basic usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.timestreamwrite.Table("example", {
databaseName: exampleAwsTimestreamwriteDatabase.databaseName,
tableName: "example",
});
import pulumi
import pulumi_aws as aws
example = aws.timestreamwrite.Table("example",
database_name=example_aws_timestreamwrite_database["databaseName"],
table_name="example")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/timestreamwrite"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := timestreamwrite.NewTable(ctx, "example", ×treamwrite.TableArgs{
DatabaseName: pulumi.Any(exampleAwsTimestreamwriteDatabase.DatabaseName),
TableName: pulumi.String("example"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.TimestreamWrite.Table("example", new()
{
DatabaseName = exampleAwsTimestreamwriteDatabase.DatabaseName,
TableName = "example",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.timestreamwrite.Table;
import com.pulumi.aws.timestreamwrite.TableArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Table("example", TableArgs.builder()
.databaseName(exampleAwsTimestreamwriteDatabase.get("databaseName"))
.tableName("example")
.build());
}
}
resources:
example:
type: aws:timestreamwrite:Table
properties:
databaseName: ${exampleAwsTimestreamwriteDatabase.databaseName}
tableName: example
terraform {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_timestreamwrite_table" "example" {
lifecycle {
create_before_destroy = true
}
database_name = exampleAwsTimestreamwriteDatabase.databaseName
table_name = "example"
}
Full usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.timestreamwrite.Table("example", {
retentionProperties: {
magneticStoreRetentionPeriodInDays: 30,
memoryStoreRetentionPeriodInHours: 8,
},
databaseName: exampleAwsTimestreamwriteDatabase.databaseName,
tableName: "example",
tags: {
Name: "example-timestream-table",
},
});
import pulumi
import pulumi_aws as aws
example = aws.timestreamwrite.Table("example",
retention_properties={
"magnetic_store_retention_period_in_days": 30,
"memory_store_retention_period_in_hours": 8,
},
database_name=example_aws_timestreamwrite_database["databaseName"],
table_name="example",
tags={
"Name": "example-timestream-table",
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/timestreamwrite"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := timestreamwrite.NewTable(ctx, "example", ×treamwrite.TableArgs{
RetentionProperties: ×treamwrite.TableRetentionPropertiesArgs{
MagneticStoreRetentionPeriodInDays: pulumi.Int(30),
MemoryStoreRetentionPeriodInHours: pulumi.Int(8),
},
DatabaseName: pulumi.Any(exampleAwsTimestreamwriteDatabase.DatabaseName),
TableName: pulumi.String("example"),
Tags: pulumi.StringMap{
"Name": pulumi.String("example-timestream-table"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.TimestreamWrite.Table("example", new()
{
RetentionProperties = new Aws.TimestreamWrite.Inputs.TableRetentionPropertiesArgs
{
MagneticStoreRetentionPeriodInDays = 30,
MemoryStoreRetentionPeriodInHours = 8,
},
DatabaseName = exampleAwsTimestreamwriteDatabase.DatabaseName,
TableName = "example",
Tags =
{
{ "Name", "example-timestream-table" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.timestreamwrite.Table;
import com.pulumi.aws.timestreamwrite.TableArgs;
import com.pulumi.aws.timestreamwrite.inputs.TableRetentionPropertiesArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Table("example", TableArgs.builder()
.retentionProperties(TableRetentionPropertiesArgs.builder()
.magneticStoreRetentionPeriodInDays(30)
.memoryStoreRetentionPeriodInHours(8)
.build())
.databaseName(exampleAwsTimestreamwriteDatabase.get("databaseName"))
.tableName("example")
.tags(Map.of("Name", "example-timestream-table"))
.build());
}
}
resources:
example:
type: aws:timestreamwrite:Table
properties:
retentionProperties:
magneticStoreRetentionPeriodInDays: 30
memoryStoreRetentionPeriodInHours: 8
databaseName: ${exampleAwsTimestreamwriteDatabase.databaseName}
tableName: example
tags:
Name: example-timestream-table
terraform {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_timestreamwrite_table" "example" {
lifecycle {
create_before_destroy = true
}
retention_properties {
magnetic_store_retention_period_in_days = 30
memory_store_retention_period_in_hours = 8
}
database_name = exampleAwsTimestreamwriteDatabase.databaseName
table_name = "example"
tags = {
"Name" = "example-timestream-table"
}
}
Customer-defined Partition Key
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.timestreamwrite.Table("example", {
schema: {
compositePartitionKey: {
enforcementInRecord: "REQUIRED",
name: "attr1",
type: "DIMENSION",
},
},
databaseName: exampleAwsTimestreamwriteDatabase.databaseName,
tableName: "example",
});
import pulumi
import pulumi_aws as aws
example = aws.timestreamwrite.Table("example",
schema={
"composite_partition_key": {
"enforcement_in_record": "REQUIRED",
"name": "attr1",
"type": "DIMENSION",
},
},
database_name=example_aws_timestreamwrite_database["databaseName"],
table_name="example")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/timestreamwrite"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := timestreamwrite.NewTable(ctx, "example", ×treamwrite.TableArgs{
Schema: ×treamwrite.TableSchemaArgs{
CompositePartitionKey: ×treamwrite.TableSchemaCompositePartitionKeyArgs{
EnforcementInRecord: pulumi.String("REQUIRED"),
Name: pulumi.String("attr1"),
Type: pulumi.String("DIMENSION"),
},
},
DatabaseName: pulumi.Any(exampleAwsTimestreamwriteDatabase.DatabaseName),
TableName: pulumi.String("example"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.TimestreamWrite.Table("example", new()
{
Schema = new Aws.TimestreamWrite.Inputs.TableSchemaArgs
{
CompositePartitionKey = new Aws.TimestreamWrite.Inputs.TableSchemaCompositePartitionKeyArgs
{
EnforcementInRecord = "REQUIRED",
Name = "attr1",
Type = "DIMENSION",
},
},
DatabaseName = exampleAwsTimestreamwriteDatabase.DatabaseName,
TableName = "example",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.timestreamwrite.Table;
import com.pulumi.aws.timestreamwrite.TableArgs;
import com.pulumi.aws.timestreamwrite.inputs.TableSchemaArgs;
import com.pulumi.aws.timestreamwrite.inputs.TableSchemaCompositePartitionKeyArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Table("example", TableArgs.builder()
.schema(TableSchemaArgs.builder()
.compositePartitionKey(TableSchemaCompositePartitionKeyArgs.builder()
.enforcementInRecord("REQUIRED")
.name("attr1")
.type("DIMENSION")
.build())
.build())
.databaseName(exampleAwsTimestreamwriteDatabase.get("databaseName"))
.tableName("example")
.build());
}
}
resources:
example:
type: aws:timestreamwrite:Table
properties:
schema:
compositePartitionKey:
enforcementInRecord: REQUIRED
name: attr1
type: DIMENSION
databaseName: ${exampleAwsTimestreamwriteDatabase.databaseName}
tableName: example
terraform {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_timestreamwrite_table" "example" {
lifecycle {
create_before_destroy = true
}
schema {
composite_partition_key {
enforcement_in_record = "REQUIRED"
name = "attr1"
type = "DIMENSION"
}
}
database_name = exampleAwsTimestreamwriteDatabase.databaseName
table_name = "example"
}
Create Table Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Table(name: string, args: TableArgs, opts?: CustomResourceOptions);@overload
def Table(resource_name: str,
args: TableArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Table(resource_name: str,
opts: Optional[ResourceOptions] = None,
database_name: Optional[str] = None,
table_name: Optional[str] = None,
magnetic_store_write_properties: Optional[TableMagneticStoreWritePropertiesArgs] = None,
region: Optional[str] = None,
retention_properties: Optional[TableRetentionPropertiesArgs] = None,
schema: Optional[TableSchemaArgs] = None,
tags: Optional[Mapping[str, str]] = None)func NewTable(ctx *Context, name string, args TableArgs, opts ...ResourceOption) (*Table, error)public Table(string name, TableArgs args, CustomResourceOptions? opts = null)type: aws:timestreamwrite:Table
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws_timestreamwrite_table" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args TableArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args TableArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args TableArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TableArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TableArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var exampletableResourceResourceFromTimestreamwritetable = new Aws.TimestreamWrite.Table("exampletableResourceResourceFromTimestreamwritetable", new()
{
DatabaseName = "string",
TableName = "string",
MagneticStoreWriteProperties = new Aws.TimestreamWrite.Inputs.TableMagneticStoreWritePropertiesArgs
{
EnableMagneticStoreWrites = false,
MagneticStoreRejectedDataLocation = new Aws.TimestreamWrite.Inputs.TableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationArgs
{
S3Configuration = new Aws.TimestreamWrite.Inputs.TableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3ConfigurationArgs
{
BucketName = "string",
EncryptionOption = "string",
KmsKeyId = "string",
ObjectKeyPrefix = "string",
},
},
},
Region = "string",
RetentionProperties = new Aws.TimestreamWrite.Inputs.TableRetentionPropertiesArgs
{
MagneticStoreRetentionPeriodInDays = 0,
MemoryStoreRetentionPeriodInHours = 0,
},
Schema = new Aws.TimestreamWrite.Inputs.TableSchemaArgs
{
CompositePartitionKey = new Aws.TimestreamWrite.Inputs.TableSchemaCompositePartitionKeyArgs
{
Type = "string",
EnforcementInRecord = "string",
Name = "string",
},
},
Tags =
{
{ "string", "string" },
},
});
example, err := timestreamwrite.NewTable(ctx, "exampletableResourceResourceFromTimestreamwritetable", ×treamwrite.TableArgs{
DatabaseName: pulumi.String("string"),
TableName: pulumi.String("string"),
MagneticStoreWriteProperties: ×treamwrite.TableMagneticStoreWritePropertiesArgs{
EnableMagneticStoreWrites: pulumi.Bool(false),
MagneticStoreRejectedDataLocation: ×treamwrite.TableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationArgs{
S3Configuration: ×treamwrite.TableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3ConfigurationArgs{
BucketName: pulumi.String("string"),
EncryptionOption: pulumi.String("string"),
KmsKeyId: pulumi.String("string"),
ObjectKeyPrefix: pulumi.String("string"),
},
},
},
Region: pulumi.String("string"),
RetentionProperties: ×treamwrite.TableRetentionPropertiesArgs{
MagneticStoreRetentionPeriodInDays: pulumi.Int(0),
MemoryStoreRetentionPeriodInHours: pulumi.Int(0),
},
Schema: ×treamwrite.TableSchemaArgs{
CompositePartitionKey: ×treamwrite.TableSchemaCompositePartitionKeyArgs{
Type: pulumi.String("string"),
EnforcementInRecord: pulumi.String("string"),
Name: pulumi.String("string"),
},
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
resource "aws_timestreamwrite_table" "exampletableResourceResourceFromTimestreamwritetable" {
lifecycle {
create_before_destroy = true
}
database_name = "string"
table_name = "string"
magnetic_store_write_properties = {
enable_magnetic_store_writes = false
magnetic_store_rejected_data_location = {
s3_configuration = {
bucket_name = "string"
encryption_option = "string"
kms_key_id = "string"
object_key_prefix = "string"
}
}
}
region = "string"
retention_properties = {
magnetic_store_retention_period_in_days = 0
memory_store_retention_period_in_hours = 0
}
schema = {
composite_partition_key = {
type = "string"
enforcement_in_record = "string"
name = "string"
}
}
tags = {
"string" = "string"
}
}
var exampletableResourceResourceFromTimestreamwritetable = new com.pulumi.aws.timestreamwrite.Table("exampletableResourceResourceFromTimestreamwritetable", com.pulumi.aws.timestreamwrite.TableArgs.builder()
.databaseName("string")
.tableName("string")
.magneticStoreWriteProperties(TableMagneticStoreWritePropertiesArgs.builder()
.enableMagneticStoreWrites(false)
.magneticStoreRejectedDataLocation(TableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationArgs.builder()
.s3Configuration(TableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3ConfigurationArgs.builder()
.bucketName("string")
.encryptionOption("string")
.kmsKeyId("string")
.objectKeyPrefix("string")
.build())
.build())
.build())
.region("string")
.retentionProperties(TableRetentionPropertiesArgs.builder()
.magneticStoreRetentionPeriodInDays(0)
.memoryStoreRetentionPeriodInHours(0)
.build())
.schema(TableSchemaArgs.builder()
.compositePartitionKey(TableSchemaCompositePartitionKeyArgs.builder()
.type("string")
.enforcementInRecord("string")
.name("string")
.build())
.build())
.tags(Map.of("string", "string"))
.build());
exampletable_resource_resource_from_timestreamwritetable = aws.timestreamwrite.Table("exampletableResourceResourceFromTimestreamwritetable",
database_name="string",
table_name="string",
magnetic_store_write_properties={
"enable_magnetic_store_writes": False,
"magnetic_store_rejected_data_location": {
"s3_configuration": {
"bucket_name": "string",
"encryption_option": "string",
"kms_key_id": "string",
"object_key_prefix": "string",
},
},
},
region="string",
retention_properties={
"magnetic_store_retention_period_in_days": 0,
"memory_store_retention_period_in_hours": 0,
},
schema={
"composite_partition_key": {
"type": "string",
"enforcement_in_record": "string",
"name": "string",
},
},
tags={
"string": "string",
})
const exampletableResourceResourceFromTimestreamwritetable = new aws.timestreamwrite.Table("exampletableResourceResourceFromTimestreamwritetable", {
databaseName: "string",
tableName: "string",
magneticStoreWriteProperties: {
enableMagneticStoreWrites: false,
magneticStoreRejectedDataLocation: {
s3Configuration: {
bucketName: "string",
encryptionOption: "string",
kmsKeyId: "string",
objectKeyPrefix: "string",
},
},
},
region: "string",
retentionProperties: {
magneticStoreRetentionPeriodInDays: 0,
memoryStoreRetentionPeriodInHours: 0,
},
schema: {
compositePartitionKey: {
type: "string",
enforcementInRecord: "string",
name: "string",
},
},
tags: {
string: "string",
},
});
type: aws:timestreamwrite:Table
properties:
databaseName: string
magneticStoreWriteProperties:
enableMagneticStoreWrites: false
magneticStoreRejectedDataLocation:
s3Configuration:
bucketName: string
encryptionOption: string
kmsKeyId: string
objectKeyPrefix: string
region: string
retentionProperties:
magneticStoreRetentionPeriodInDays: 0
memoryStoreRetentionPeriodInHours: 0
schema:
compositePartitionKey:
enforcementInRecord: string
name: string
type: string
tableName: string
tags:
string: string
Table Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Table resource accepts the following input properties:
- Database
Name string - Name of the Timestream database.
- Table
Name string - Name of the Timestream table.
- Magnetic
Store TableWrite Properties Magnetic Store Write Properties - Properties to set on the table when enabling magnetic store writes. See
magneticStoreWritePropertiesBlock below for more details. - Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Retention
Properties TableRetention Properties - Retention duration for the memory store and magnetic store. See
retentionPropertiesBlock below for more details. If not provided,magneticStoreRetentionPeriodInDaysdefaults to 73000 andmemoryStoreRetentionPeriodInHoursdefaults to 6. - Schema
Table
Schema - Schema of the table. See
schemaBlock below for more details. - Dictionary<string, string>
- Map of tags to assign to this resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Database
Name string - Name of the Timestream database.
- Table
Name string - Name of the Timestream table.
- Magnetic
Store TableWrite Properties Magnetic Store Write Properties Args - Properties to set on the table when enabling magnetic store writes. See
magneticStoreWritePropertiesBlock below for more details. - Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Retention
Properties TableRetention Properties Args - Retention duration for the memory store and magnetic store. See
retentionPropertiesBlock below for more details. If not provided,magneticStoreRetentionPeriodInDaysdefaults to 73000 andmemoryStoreRetentionPeriodInHoursdefaults to 6. - Schema
Table
Schema Args - Schema of the table. See
schemaBlock below for more details. - map[string]string
- Map of tags to assign to this resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- database_
name string - Name of the Timestream database.
- table_
name string - Name of the Timestream table.
- magnetic_
store_ objectwrite_ properties - Properties to set on the table when enabling magnetic store writes. See
magneticStoreWritePropertiesBlock below for more details. - region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- retention_
properties object - Retention duration for the memory store and magnetic store. See
retentionPropertiesBlock below for more details. If not provided,magneticStoreRetentionPeriodInDaysdefaults to 73000 andmemoryStoreRetentionPeriodInHoursdefaults to 6. - schema object
- Schema of the table. See
schemaBlock below for more details. - map(string)
- Map of tags to assign to this resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- database
Name String - Name of the Timestream database.
- table
Name String - Name of the Timestream table.
- magnetic
Store TableWrite Properties Magnetic Store Write Properties - Properties to set on the table when enabling magnetic store writes. See
magneticStoreWritePropertiesBlock below for more details. - region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- retention
Properties TableRetention Properties - Retention duration for the memory store and magnetic store. See
retentionPropertiesBlock below for more details. If not provided,magneticStoreRetentionPeriodInDaysdefaults to 73000 andmemoryStoreRetentionPeriodInHoursdefaults to 6. - schema
Table
Schema - Schema of the table. See
schemaBlock below for more details. - Map<String,String>
- Map of tags to assign to this resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- database
Name string - Name of the Timestream database.
- table
Name string - Name of the Timestream table.
- magnetic
Store TableWrite Properties Magnetic Store Write Properties - Properties to set on the table when enabling magnetic store writes. See
magneticStoreWritePropertiesBlock below for more details. - region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- retention
Properties TableRetention Properties - Retention duration for the memory store and magnetic store. See
retentionPropertiesBlock below for more details. If not provided,magneticStoreRetentionPeriodInDaysdefaults to 73000 andmemoryStoreRetentionPeriodInHoursdefaults to 6. - schema
Table
Schema - Schema of the table. See
schemaBlock below for more details. - {[key: string]: string}
- Map of tags to assign to this resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- database_
name str - Name of the Timestream database.
- table_
name str - Name of the Timestream table.
- magnetic_
store_ Tablewrite_ properties Magnetic Store Write Properties Args - Properties to set on the table when enabling magnetic store writes. See
magneticStoreWritePropertiesBlock below for more details. - region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- retention_
properties TableRetention Properties Args - Retention duration for the memory store and magnetic store. See
retentionPropertiesBlock below for more details. If not provided,magneticStoreRetentionPeriodInDaysdefaults to 73000 andmemoryStoreRetentionPeriodInHoursdefaults to 6. - schema
Table
Schema Args - Schema of the table. See
schemaBlock below for more details. - Mapping[str, str]
- Map of tags to assign to this resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- database
Name String - Name of the Timestream database.
- table
Name String - Name of the Timestream table.
- magnetic
Store Property MapWrite Properties - Properties to set on the table when enabling magnetic store writes. See
magneticStoreWritePropertiesBlock below for more details. - region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- retention
Properties Property Map - Retention duration for the memory store and magnetic store. See
retentionPropertiesBlock below for more details. If not provided,magneticStoreRetentionPeriodInDaysdefaults to 73000 andmemoryStoreRetentionPeriodInHoursdefaults to 6. - schema Property Map
- Schema of the table. See
schemaBlock below for more details. - Map<String>
- Map of tags to assign to this resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
Outputs
All input properties are implicitly available as output properties. Additionally, the Table resource produces the following output properties:
Look up Existing Table Resource
Get an existing Table resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: TableState, opts?: CustomResourceOptions): Table@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
database_name: Optional[str] = None,
magnetic_store_write_properties: Optional[TableMagneticStoreWritePropertiesArgs] = None,
region: Optional[str] = None,
retention_properties: Optional[TableRetentionPropertiesArgs] = None,
schema: Optional[TableSchemaArgs] = None,
table_name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None) -> Tablefunc GetTable(ctx *Context, name string, id IDInput, state *TableState, opts ...ResourceOption) (*Table, error)public static Table Get(string name, Input<string> id, TableState? state, CustomResourceOptions? opts = null)public static Table get(String name, Output<String> id, TableState state, CustomResourceOptions options)resources: _: type: aws:timestreamwrite:Table get: id: ${id}import {
to = aws_timestreamwrite_table.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
- ARN that uniquely identifies this table.
- Database
Name string - Name of the Timestream database.
- Magnetic
Store TableWrite Properties Magnetic Store Write Properties - Properties to set on the table when enabling magnetic store writes. See
magneticStoreWritePropertiesBlock below for more details. - Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Retention
Properties TableRetention Properties - Retention duration for the memory store and magnetic store. See
retentionPropertiesBlock below for more details. If not provided,magneticStoreRetentionPeriodInDaysdefaults to 73000 andmemoryStoreRetentionPeriodInHoursdefaults to 6. - Schema
Table
Schema - Schema of the table. See
schemaBlock below for more details. - Table
Name string - Name of the Timestream table.
- Dictionary<string, string>
- Map of tags to assign to this resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.
- Arn string
- ARN that uniquely identifies this table.
- Database
Name string - Name of the Timestream database.
- Magnetic
Store TableWrite Properties Magnetic Store Write Properties Args - Properties to set on the table when enabling magnetic store writes. See
magneticStoreWritePropertiesBlock below for more details. - Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Retention
Properties TableRetention Properties Args - Retention duration for the memory store and magnetic store. See
retentionPropertiesBlock below for more details. If not provided,magneticStoreRetentionPeriodInDaysdefaults to 73000 andmemoryStoreRetentionPeriodInHoursdefaults to 6. - Schema
Table
Schema Args - Schema of the table. See
schemaBlock below for more details. - Table
Name string - Name of the Timestream table.
- map[string]string
- Map of tags to assign to this resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.
- arn string
- ARN that uniquely identifies this table.
- database_
name string - Name of the Timestream database.
- magnetic_
store_ objectwrite_ properties - Properties to set on the table when enabling magnetic store writes. See
magneticStoreWritePropertiesBlock below for more details. - region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- retention_
properties object - Retention duration for the memory store and magnetic store. See
retentionPropertiesBlock below for more details. If not provided,magneticStoreRetentionPeriodInDaysdefaults to 73000 andmemoryStoreRetentionPeriodInHoursdefaults to 6. - schema object
- Schema of the table. See
schemaBlock below for more details. - table_
name string - Name of the Timestream table.
- map(string)
- Map of tags to assign to this resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - map(string)
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.
- arn String
- ARN that uniquely identifies this table.
- database
Name String - Name of the Timestream database.
- magnetic
Store TableWrite Properties Magnetic Store Write Properties - Properties to set on the table when enabling magnetic store writes. See
magneticStoreWritePropertiesBlock below for more details. - region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- retention
Properties TableRetention Properties - Retention duration for the memory store and magnetic store. See
retentionPropertiesBlock below for more details. If not provided,magneticStoreRetentionPeriodInDaysdefaults to 73000 andmemoryStoreRetentionPeriodInHoursdefaults to 6. - schema
Table
Schema - Schema of the table. See
schemaBlock below for more details. - table
Name String - Name of the Timestream table.
- Map<String,String>
- Map of tags to assign to this resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.
- arn string
- ARN that uniquely identifies this table.
- database
Name string - Name of the Timestream database.
- magnetic
Store TableWrite Properties Magnetic Store Write Properties - Properties to set on the table when enabling magnetic store writes. See
magneticStoreWritePropertiesBlock below for more details. - region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- retention
Properties TableRetention Properties - Retention duration for the memory store and magnetic store. See
retentionPropertiesBlock below for more details. If not provided,magneticStoreRetentionPeriodInDaysdefaults to 73000 andmemoryStoreRetentionPeriodInHoursdefaults to 6. - schema
Table
Schema - Schema of the table. See
schemaBlock below for more details. - table
Name string - Name of the Timestream table.
- {[key: string]: string}
- Map of tags to assign to this resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.
- arn str
- ARN that uniquely identifies this table.
- database_
name str - Name of the Timestream database.
- magnetic_
store_ Tablewrite_ properties Magnetic Store Write Properties Args - Properties to set on the table when enabling magnetic store writes. See
magneticStoreWritePropertiesBlock below for more details. - region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- retention_
properties TableRetention Properties Args - Retention duration for the memory store and magnetic store. See
retentionPropertiesBlock below for more details. If not provided,magneticStoreRetentionPeriodInDaysdefaults to 73000 andmemoryStoreRetentionPeriodInHoursdefaults to 6. - schema
Table
Schema Args - Schema of the table. See
schemaBlock below for more details. - table_
name str - Name of the Timestream table.
- Mapping[str, str]
- Map of tags to assign to this resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.
- arn String
- ARN that uniquely identifies this table.
- database
Name String - Name of the Timestream database.
- magnetic
Store Property MapWrite Properties - Properties to set on the table when enabling magnetic store writes. See
magneticStoreWritePropertiesBlock below for more details. - region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- retention
Properties Property Map - Retention duration for the memory store and magnetic store. See
retentionPropertiesBlock below for more details. If not provided,magneticStoreRetentionPeriodInDaysdefaults to 73000 andmemoryStoreRetentionPeriodInHoursdefaults to 6. - schema Property Map
- Schema of the table. See
schemaBlock below for more details. - table
Name String - Name of the Timestream table.
- Map<String>
- Map of tags to assign to this resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.
Supporting Types
TableMagneticStoreWriteProperties, TableMagneticStoreWritePropertiesArgs
- Enable
Magnetic boolStore Writes - Whether to enable magnetic store writes.
- Magnetic
Store TableRejected Data Location Magnetic Store Write Properties Magnetic Store Rejected Data Location - Location to write error reports for records rejected asynchronously during magnetic store writes. See
magneticStoreRejectedDataLocationBlock below for more details.
- Enable
Magnetic boolStore Writes - Whether to enable magnetic store writes.
- Magnetic
Store TableRejected Data Location Magnetic Store Write Properties Magnetic Store Rejected Data Location - Location to write error reports for records rejected asynchronously during magnetic store writes. See
magneticStoreRejectedDataLocationBlock below for more details.
- enable_
magnetic_ boolstore_ writes - Whether to enable magnetic store writes.
- magnetic_
store_ objectrejected_ data_ location - Location to write error reports for records rejected asynchronously during magnetic store writes. See
magneticStoreRejectedDataLocationBlock below for more details.
- enable
Magnetic BooleanStore Writes - Whether to enable magnetic store writes.
- magnetic
Store TableRejected Data Location Magnetic Store Write Properties Magnetic Store Rejected Data Location - Location to write error reports for records rejected asynchronously during magnetic store writes. See
magneticStoreRejectedDataLocationBlock below for more details.
- enable
Magnetic booleanStore Writes - Whether to enable magnetic store writes.
- magnetic
Store TableRejected Data Location Magnetic Store Write Properties Magnetic Store Rejected Data Location - Location to write error reports for records rejected asynchronously during magnetic store writes. See
magneticStoreRejectedDataLocationBlock below for more details.
- enable_
magnetic_ boolstore_ writes - Whether to enable magnetic store writes.
- magnetic_
store_ Tablerejected_ data_ location Magnetic Store Write Properties Magnetic Store Rejected Data Location - Location to write error reports for records rejected asynchronously during magnetic store writes. See
magneticStoreRejectedDataLocationBlock below for more details.
- enable
Magnetic BooleanStore Writes - Whether to enable magnetic store writes.
- magnetic
Store Property MapRejected Data Location - Location to write error reports for records rejected asynchronously during magnetic store writes. See
magneticStoreRejectedDataLocationBlock below for more details.
TableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocation, TableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationArgs
- S3Configuration
Table
Magnetic Store Write Properties Magnetic Store Rejected Data Location S3Configuration - Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes. See
s3ConfigurationBlock below for more details.
- S3Configuration
Table
Magnetic Store Write Properties Magnetic Store Rejected Data Location S3Configuration - Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes. See
s3ConfigurationBlock below for more details.
- s3_
configuration object - Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes. See
s3ConfigurationBlock below for more details.
- s3Configuration
Table
Magnetic Store Write Properties Magnetic Store Rejected Data Location S3Configuration - Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes. See
s3ConfigurationBlock below for more details.
- s3Configuration
Table
Magnetic Store Write Properties Magnetic Store Rejected Data Location S3Configuration - Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes. See
s3ConfigurationBlock below for more details.
- s3_
configuration TableMagnetic Store Write Properties Magnetic Store Rejected Data Location S3Configuration - Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes. See
s3ConfigurationBlock below for more details.
- s3Configuration Property Map
- Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes. See
s3ConfigurationBlock below for more details.
TableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3Configuration, TableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3ConfigurationArgs
- Bucket
Name string - Bucket name of the customer S3 bucket.
- Encryption
Option string - Encryption option for the customer s3 location. Options are S3 server side encryption with an S3-managed key or KMS managed key. Valid values are
SSE_KMSandSSE_S3. - Kms
Key stringId - KMS key ARN for the customer s3 location when encrypting with a KMS managed key.
- Object
Key stringPrefix - Object key prefix for the customer S3 location.
- Bucket
Name string - Bucket name of the customer S3 bucket.
- Encryption
Option string - Encryption option for the customer s3 location. Options are S3 server side encryption with an S3-managed key or KMS managed key. Valid values are
SSE_KMSandSSE_S3. - Kms
Key stringId - KMS key ARN for the customer s3 location when encrypting with a KMS managed key.
- Object
Key stringPrefix - Object key prefix for the customer S3 location.
- bucket_
name string - Bucket name of the customer S3 bucket.
- encryption_
option string - Encryption option for the customer s3 location. Options are S3 server side encryption with an S3-managed key or KMS managed key. Valid values are
SSE_KMSandSSE_S3. - kms_
key_ stringid - KMS key ARN for the customer s3 location when encrypting with a KMS managed key.
- object_
key_ stringprefix - Object key prefix for the customer S3 location.
- bucket
Name String - Bucket name of the customer S3 bucket.
- encryption
Option String - Encryption option for the customer s3 location. Options are S3 server side encryption with an S3-managed key or KMS managed key. Valid values are
SSE_KMSandSSE_S3. - kms
Key StringId - KMS key ARN for the customer s3 location when encrypting with a KMS managed key.
- object
Key StringPrefix - Object key prefix for the customer S3 location.
- bucket
Name string - Bucket name of the customer S3 bucket.
- encryption
Option string - Encryption option for the customer s3 location. Options are S3 server side encryption with an S3-managed key or KMS managed key. Valid values are
SSE_KMSandSSE_S3. - kms
Key stringId - KMS key ARN for the customer s3 location when encrypting with a KMS managed key.
- object
Key stringPrefix - Object key prefix for the customer S3 location.
- bucket_
name str - Bucket name of the customer S3 bucket.
- encryption_
option str - Encryption option for the customer s3 location. Options are S3 server side encryption with an S3-managed key or KMS managed key. Valid values are
SSE_KMSandSSE_S3. - kms_
key_ strid - KMS key ARN for the customer s3 location when encrypting with a KMS managed key.
- object_
key_ strprefix - Object key prefix for the customer S3 location.
- bucket
Name String - Bucket name of the customer S3 bucket.
- encryption
Option String - Encryption option for the customer s3 location. Options are S3 server side encryption with an S3-managed key or KMS managed key. Valid values are
SSE_KMSandSSE_S3. - kms
Key StringId - KMS key ARN for the customer s3 location when encrypting with a KMS managed key.
- object
Key StringPrefix - Object key prefix for the customer S3 location.
TableRetentionProperties, TableRetentionPropertiesArgs
- Magnetic
Store intRetention Period In Days - Duration for which data must be stored in the magnetic store. Minimum value of 1. Maximum value of 73000.
- Memory
Store intRetention Period In Hours - Duration for which data must be stored in the memory store. Minimum value of 1. Maximum value of 8766.
- Magnetic
Store intRetention Period In Days - Duration for which data must be stored in the magnetic store. Minimum value of 1. Maximum value of 73000.
- Memory
Store intRetention Period In Hours - Duration for which data must be stored in the memory store. Minimum value of 1. Maximum value of 8766.
- magnetic_
store_ numberretention_ period_ in_ days - Duration for which data must be stored in the magnetic store. Minimum value of 1. Maximum value of 73000.
- memory_
store_ numberretention_ period_ in_ hours - Duration for which data must be stored in the memory store. Minimum value of 1. Maximum value of 8766.
- magnetic
Store IntegerRetention Period In Days - Duration for which data must be stored in the magnetic store. Minimum value of 1. Maximum value of 73000.
- memory
Store IntegerRetention Period In Hours - Duration for which data must be stored in the memory store. Minimum value of 1. Maximum value of 8766.
- magnetic
Store numberRetention Period In Days - Duration for which data must be stored in the magnetic store. Minimum value of 1. Maximum value of 73000.
- memory
Store numberRetention Period In Hours - Duration for which data must be stored in the memory store. Minimum value of 1. Maximum value of 8766.
- magnetic_
store_ intretention_ period_ in_ days - Duration for which data must be stored in the magnetic store. Minimum value of 1. Maximum value of 73000.
- memory_
store_ intretention_ period_ in_ hours - Duration for which data must be stored in the memory store. Minimum value of 1. Maximum value of 8766.
- magnetic
Store NumberRetention Period In Days - Duration for which data must be stored in the magnetic store. Minimum value of 1. Maximum value of 73000.
- memory
Store NumberRetention Period In Hours - Duration for which data must be stored in the memory store. Minimum value of 1. Maximum value of 8766.
TableSchema, TableSchemaArgs
- Composite
Partition TableKey Schema Composite Partition Key - Non-empty list of partition keys defining the attributes used to partition the table data. The order of the list determines the partition hierarchy. The name and type of each partition key as well as the partition key order cannot be changed after the table is created. However, the enforcement level of each partition key can be changed. See
compositePartitionKeyBlock below for more details.
- Composite
Partition TableKey Schema Composite Partition Key - Non-empty list of partition keys defining the attributes used to partition the table data. The order of the list determines the partition hierarchy. The name and type of each partition key as well as the partition key order cannot be changed after the table is created. However, the enforcement level of each partition key can be changed. See
compositePartitionKeyBlock below for more details.
- composite_
partition_ objectkey - Non-empty list of partition keys defining the attributes used to partition the table data. The order of the list determines the partition hierarchy. The name and type of each partition key as well as the partition key order cannot be changed after the table is created. However, the enforcement level of each partition key can be changed. See
compositePartitionKeyBlock below for more details.
- composite
Partition TableKey Schema Composite Partition Key - Non-empty list of partition keys defining the attributes used to partition the table data. The order of the list determines the partition hierarchy. The name and type of each partition key as well as the partition key order cannot be changed after the table is created. However, the enforcement level of each partition key can be changed. See
compositePartitionKeyBlock below for more details.
- composite
Partition TableKey Schema Composite Partition Key - Non-empty list of partition keys defining the attributes used to partition the table data. The order of the list determines the partition hierarchy. The name and type of each partition key as well as the partition key order cannot be changed after the table is created. However, the enforcement level of each partition key can be changed. See
compositePartitionKeyBlock below for more details.
- composite_
partition_ Tablekey Schema Composite Partition Key - Non-empty list of partition keys defining the attributes used to partition the table data. The order of the list determines the partition hierarchy. The name and type of each partition key as well as the partition key order cannot be changed after the table is created. However, the enforcement level of each partition key can be changed. See
compositePartitionKeyBlock below for more details.
- composite
Partition Property MapKey - Non-empty list of partition keys defining the attributes used to partition the table data. The order of the list determines the partition hierarchy. The name and type of each partition key as well as the partition key order cannot be changed after the table is created. However, the enforcement level of each partition key can be changed. See
compositePartitionKeyBlock below for more details.
TableSchemaCompositePartitionKey, TableSchemaCompositePartitionKeyArgs
- Type string
- Type of the partition key. Valid values:
DIMENSION,MEASURE. - Enforcement
In stringRecord - Level of enforcement for the specification of a dimension key in ingested records. Valid values:
REQUIRED,OPTIONAL. - Name string
- Name of the attribute used for a dimension key.
- Type string
- Type of the partition key. Valid values:
DIMENSION,MEASURE. - Enforcement
In stringRecord - Level of enforcement for the specification of a dimension key in ingested records. Valid values:
REQUIRED,OPTIONAL. - Name string
- Name of the attribute used for a dimension key.
- type string
- Type of the partition key. Valid values:
DIMENSION,MEASURE. - enforcement_
in_ stringrecord - Level of enforcement for the specification of a dimension key in ingested records. Valid values:
REQUIRED,OPTIONAL. - name string
- Name of the attribute used for a dimension key.
- type String
- Type of the partition key. Valid values:
DIMENSION,MEASURE. - enforcement
In StringRecord - Level of enforcement for the specification of a dimension key in ingested records. Valid values:
REQUIRED,OPTIONAL. - name String
- Name of the attribute used for a dimension key.
- type string
- Type of the partition key. Valid values:
DIMENSION,MEASURE. - enforcement
In stringRecord - Level of enforcement for the specification of a dimension key in ingested records. Valid values:
REQUIRED,OPTIONAL. - name string
- Name of the attribute used for a dimension key.
- type str
- Type of the partition key. Valid values:
DIMENSION,MEASURE. - enforcement_
in_ strrecord - Level of enforcement for the specification of a dimension key in ingested records. Valid values:
REQUIRED,OPTIONAL. - name str
- Name of the attribute used for a dimension key.
- type String
- Type of the partition key. Valid values:
DIMENSION,MEASURE. - enforcement
In StringRecord - Level of enforcement for the specification of a dimension key in ingested records. Valid values:
REQUIRED,OPTIONAL. - name String
- Name of the attribute used for a dimension key.
Import
Using pulumi import, import Timestream tables using the tableName and databaseName separate by a colon (:). For example:
$ pulumi import aws:timestreamwrite/table:Table example ExampleTable:ExampleDatabase
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.
published on Monday, Nov 2, 2026 by Pulumi