Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. timestreamwrite
  5. Table
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

aws.timestreamwrite.Table

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

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",
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.timestreamwrite.Table("example",
    database_name=example_aws_timestreamwrite_database["databaseName"],
    table_name="example")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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", &timestreamwrite.TableArgs{
			DatabaseName: pulumi.Any(exampleAwsTimestreamwriteDatabase.DatabaseName),
			TableName:    pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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",
    });

});
Copy
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.List;
import java.util.ArrayList;
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.databaseName())
            .tableName("example")
            .build());

    }
}
Copy
resources:
  example:
    type: aws:timestreamwrite:Table
    properties:
      databaseName: ${exampleAwsTimestreamwriteDatabase.databaseName}
      tableName: example
Copy

Full 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",
    retentionProperties: {
        magneticStoreRetentionPeriodInDays: 30,
        memoryStoreRetentionPeriodInHours: 8,
    },
    tags: {
        Name: "example-timestream-table",
    },
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.timestreamwrite.Table("example",
    database_name=example_aws_timestreamwrite_database["databaseName"],
    table_name="example",
    retention_properties={
        "magnetic_store_retention_period_in_days": 30,
        "memory_store_retention_period_in_hours": 8,
    },
    tags={
        "Name": "example-timestream-table",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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", &timestreamwrite.TableArgs{
			DatabaseName: pulumi.Any(exampleAwsTimestreamwriteDatabase.DatabaseName),
			TableName:    pulumi.String("example"),
			RetentionProperties: &timestreamwrite.TableRetentionPropertiesArgs{
				MagneticStoreRetentionPeriodInDays: pulumi.Int(30),
				MemoryStoreRetentionPeriodInHours:  pulumi.Int(8),
			},
			Tags: pulumi.StringMap{
				"Name": pulumi.String("example-timestream-table"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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",
        RetentionProperties = new Aws.TimestreamWrite.Inputs.TableRetentionPropertiesArgs
        {
            MagneticStoreRetentionPeriodInDays = 30,
            MemoryStoreRetentionPeriodInHours = 8,
        },
        Tags = 
        {
            { "Name", "example-timestream-table" },
        },
    });

});
Copy
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.List;
import java.util.ArrayList;
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.databaseName())
            .tableName("example")
            .retentionProperties(TableRetentionPropertiesArgs.builder()
                .magneticStoreRetentionPeriodInDays(30)
                .memoryStoreRetentionPeriodInHours(8)
                .build())
            .tags(Map.of("Name", "example-timestream-table"))
            .build());

    }
}
Copy
resources:
  example:
    type: aws:timestreamwrite:Table
    properties:
      databaseName: ${exampleAwsTimestreamwriteDatabase.databaseName}
      tableName: example
      retentionProperties:
        magneticStoreRetentionPeriodInDays: 30
        memoryStoreRetentionPeriodInHours: 8
      tags:
        Name: example-timestream-table
Copy

Customer-defined Partition Key

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.timestreamwrite.Table("example", {
    databaseName: exampleAwsTimestreamwriteDatabase.databaseName,
    tableName: "example",
    schema: {
        compositePartitionKey: {
            enforcementInRecord: "REQUIRED",
            name: "attr1",
            type: "DIMENSION",
        },
    },
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.timestreamwrite.Table("example",
    database_name=example_aws_timestreamwrite_database["databaseName"],
    table_name="example",
    schema={
        "composite_partition_key": {
            "enforcement_in_record": "REQUIRED",
            "name": "attr1",
            "type": "DIMENSION",
        },
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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", &timestreamwrite.TableArgs{
			DatabaseName: pulumi.Any(exampleAwsTimestreamwriteDatabase.DatabaseName),
			TableName:    pulumi.String("example"),
			Schema: &timestreamwrite.TableSchemaArgs{
				CompositePartitionKey: &timestreamwrite.TableSchemaCompositePartitionKeyArgs{
					EnforcementInRecord: pulumi.String("REQUIRED"),
					Name:                pulumi.String("attr1"),
					Type:                pulumi.String("DIMENSION"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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",
        Schema = new Aws.TimestreamWrite.Inputs.TableSchemaArgs
        {
            CompositePartitionKey = new Aws.TimestreamWrite.Inputs.TableSchemaCompositePartitionKeyArgs
            {
                EnforcementInRecord = "REQUIRED",
                Name = "attr1",
                Type = "DIMENSION",
            },
        },
    });

});
Copy
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.List;
import java.util.ArrayList;
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.databaseName())
            .tableName("example")
            .schema(TableSchemaArgs.builder()
                .compositePartitionKey(TableSchemaCompositePartitionKeyArgs.builder()
                    .enforcementInRecord("REQUIRED")
                    .name("attr1")
                    .type("DIMENSION")
                    .build())
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:timestreamwrite:Table
    properties:
      databaseName: ${exampleAwsTimestreamwriteDatabase.databaseName}
      tableName: example
      schema:
        compositePartitionKey:
          enforcementInRecord: REQUIRED
          name: attr1
          type: DIMENSION
Copy

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,
          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)
public Table(String name, TableArgs args)
public Table(String name, TableArgs args, CustomResourceOptions options)

type: aws:timestreamwrite:Table
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TableArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. TableArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TableArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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",
            },
        },
    },
    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" },
    },
});
Copy
example, err := timestreamwrite.NewTable(ctx, "exampletableResourceResourceFromTimestreamwritetable", &timestreamwrite.TableArgs{
	DatabaseName: pulumi.String("string"),
	TableName:    pulumi.String("string"),
	MagneticStoreWriteProperties: &timestreamwrite.TableMagneticStoreWritePropertiesArgs{
		EnableMagneticStoreWrites: pulumi.Bool(false),
		MagneticStoreRejectedDataLocation: &timestreamwrite.TableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationArgs{
			S3Configuration: &timestreamwrite.TableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3ConfigurationArgs{
				BucketName:       pulumi.String("string"),
				EncryptionOption: pulumi.String("string"),
				KmsKeyId:         pulumi.String("string"),
				ObjectKeyPrefix:  pulumi.String("string"),
			},
		},
	},
	RetentionProperties: &timestreamwrite.TableRetentionPropertiesArgs{
		MagneticStoreRetentionPeriodInDays: pulumi.Int(0),
		MemoryStoreRetentionPeriodInHours:  pulumi.Int(0),
	},
	Schema: &timestreamwrite.TableSchemaArgs{
		CompositePartitionKey: &timestreamwrite.TableSchemaCompositePartitionKeyArgs{
			Type:                pulumi.String("string"),
			EnforcementInRecord: pulumi.String("string"),
			Name:                pulumi.String("string"),
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var exampletableResourceResourceFromTimestreamwritetable = new Table("exampletableResourceResourceFromTimestreamwritetable", 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())
    .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());
Copy
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",
            },
        },
    },
    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",
    })
Copy
const exampletableResourceResourceFromTimestreamwritetable = new aws.timestreamwrite.Table("exampletableResourceResourceFromTimestreamwritetable", {
    databaseName: "string",
    tableName: "string",
    magneticStoreWriteProperties: {
        enableMagneticStoreWrites: false,
        magneticStoreRejectedDataLocation: {
            s3Configuration: {
                bucketName: "string",
                encryptionOption: "string",
                kmsKeyId: "string",
                objectKeyPrefix: "string",
            },
        },
    },
    retentionProperties: {
        magneticStoreRetentionPeriodInDays: 0,
        memoryStoreRetentionPeriodInHours: 0,
    },
    schema: {
        compositePartitionKey: {
            type: "string",
            enforcementInRecord: "string",
            name: "string",
        },
    },
    tags: {
        string: "string",
    },
});
Copy
type: aws:timestreamwrite:Table
properties:
    databaseName: string
    magneticStoreWriteProperties:
        enableMagneticStoreWrites: false
        magneticStoreRejectedDataLocation:
            s3Configuration:
                bucketName: string
                encryptionOption: string
                kmsKeyId: string
                objectKeyPrefix: string
    retentionProperties:
        magneticStoreRetentionPeriodInDays: 0
        memoryStoreRetentionPeriodInHours: 0
    schema:
        compositePartitionKey:
            enforcementInRecord: string
            name: string
            type: string
    tableName: string
    tags:
        string: string
Copy

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:

DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Timestream database.
TableName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Timestream table.
MagneticStoreWriteProperties TableMagneticStoreWriteProperties
Contains properties to set on the table when enabling magnetic store writes. See Magnetic Store Write Properties below for more details.
RetentionProperties TableRetentionProperties
The retention duration for the memory store and magnetic store. See Retention Properties below for more details. If not provided, magnetic_store_retention_period_in_days default to 73000 and memory_store_retention_period_in_hours defaults to 6.
Schema Changes to this property will trigger replacement. TableSchema
The schema of the table. See Schema below for more details.
Tags Dictionary<string, string>
Map of tags to assign to this resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Timestream database.
TableName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Timestream table.
MagneticStoreWriteProperties TableMagneticStoreWritePropertiesArgs
Contains properties to set on the table when enabling magnetic store writes. See Magnetic Store Write Properties below for more details.
RetentionProperties TableRetentionPropertiesArgs
The retention duration for the memory store and magnetic store. See Retention Properties below for more details. If not provided, magnetic_store_retention_period_in_days default to 73000 and memory_store_retention_period_in_hours defaults to 6.
Schema Changes to this property will trigger replacement. TableSchemaArgs
The schema of the table. See Schema below for more details.
Tags map[string]string
Map of tags to assign to this resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Timestream database.
tableName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Timestream table.
magneticStoreWriteProperties TableMagneticStoreWriteProperties
Contains properties to set on the table when enabling magnetic store writes. See Magnetic Store Write Properties below for more details.
retentionProperties TableRetentionProperties
The retention duration for the memory store and magnetic store. See Retention Properties below for more details. If not provided, magnetic_store_retention_period_in_days default to 73000 and memory_store_retention_period_in_hours defaults to 6.
schema Changes to this property will trigger replacement. TableSchema
The schema of the table. See Schema below for more details.
tags Map<String,String>
Map of tags to assign to this resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
databaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Timestream database.
tableName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Timestream table.
magneticStoreWriteProperties TableMagneticStoreWriteProperties
Contains properties to set on the table when enabling magnetic store writes. See Magnetic Store Write Properties below for more details.
retentionProperties TableRetentionProperties
The retention duration for the memory store and magnetic store. See Retention Properties below for more details. If not provided, magnetic_store_retention_period_in_days default to 73000 and memory_store_retention_period_in_hours defaults to 6.
schema Changes to this property will trigger replacement. TableSchema
The schema of the table. See Schema below for more details.
tags {[key: string]: string}
Map of tags to assign to this resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
database_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Timestream database.
table_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Timestream table.
magnetic_store_write_properties TableMagneticStoreWritePropertiesArgs
Contains properties to set on the table when enabling magnetic store writes. See Magnetic Store Write Properties below for more details.
retention_properties TableRetentionPropertiesArgs
The retention duration for the memory store and magnetic store. See Retention Properties below for more details. If not provided, magnetic_store_retention_period_in_days default to 73000 and memory_store_retention_period_in_hours defaults to 6.
schema Changes to this property will trigger replacement. TableSchemaArgs
The schema of the table. See Schema below for more details.
tags Mapping[str, str]
Map of tags to assign to this resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Timestream database.
tableName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Timestream table.
magneticStoreWriteProperties Property Map
Contains properties to set on the table when enabling magnetic store writes. See Magnetic Store Write Properties below for more details.
retentionProperties Property Map
The retention duration for the memory store and magnetic store. See Retention Properties below for more details. If not provided, magnetic_store_retention_period_in_days default to 73000 and memory_store_retention_period_in_hours defaults to 6.
schema Changes to this property will trigger replacement. Property Map
The schema of the table. See Schema below for more details.
tags Map<String>
Map of tags to assign to this resource. If configured with a provider default_tags configuration 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:

Arn string
The ARN that uniquely identifies this table.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
The ARN that uniquely identifies this table.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The ARN that uniquely identifies this table.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
The ARN that uniquely identifies this table.
id string
The provider-assigned unique ID for this managed resource.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
The ARN that uniquely identifies this table.
id str
The provider-assigned unique ID for this managed resource.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The ARN that uniquely identifies this table.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

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,
        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) -> Table
func 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}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
Arn string
The ARN that uniquely identifies this table.
DatabaseName Changes to this property will trigger replacement. string
The name of the Timestream database.
MagneticStoreWriteProperties TableMagneticStoreWriteProperties
Contains properties to set on the table when enabling magnetic store writes. See Magnetic Store Write Properties below for more details.
RetentionProperties TableRetentionProperties
The retention duration for the memory store and magnetic store. See Retention Properties below for more details. If not provided, magnetic_store_retention_period_in_days default to 73000 and memory_store_retention_period_in_hours defaults to 6.
Schema Changes to this property will trigger replacement. TableSchema
The schema of the table. See Schema below for more details.
TableName Changes to this property will trigger replacement. string
The name of the Timestream table.
Tags Dictionary<string, string>
Map of tags to assign to this resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
The ARN that uniquely identifies this table.
DatabaseName Changes to this property will trigger replacement. string
The name of the Timestream database.
MagneticStoreWriteProperties TableMagneticStoreWritePropertiesArgs
Contains properties to set on the table when enabling magnetic store writes. See Magnetic Store Write Properties below for more details.
RetentionProperties TableRetentionPropertiesArgs
The retention duration for the memory store and magnetic store. See Retention Properties below for more details. If not provided, magnetic_store_retention_period_in_days default to 73000 and memory_store_retention_period_in_hours defaults to 6.
Schema Changes to this property will trigger replacement. TableSchemaArgs
The schema of the table. See Schema below for more details.
TableName Changes to this property will trigger replacement. string
The name of the Timestream table.
Tags map[string]string
Map of tags to assign to this resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The ARN that uniquely identifies this table.
databaseName Changes to this property will trigger replacement. String
The name of the Timestream database.
magneticStoreWriteProperties TableMagneticStoreWriteProperties
Contains properties to set on the table when enabling magnetic store writes. See Magnetic Store Write Properties below for more details.
retentionProperties TableRetentionProperties
The retention duration for the memory store and magnetic store. See Retention Properties below for more details. If not provided, magnetic_store_retention_period_in_days default to 73000 and memory_store_retention_period_in_hours defaults to 6.
schema Changes to this property will trigger replacement. TableSchema
The schema of the table. See Schema below for more details.
tableName Changes to this property will trigger replacement. String
The name of the Timestream table.
tags Map<String,String>
Map of tags to assign to this resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
The ARN that uniquely identifies this table.
databaseName Changes to this property will trigger replacement. string
The name of the Timestream database.
magneticStoreWriteProperties TableMagneticStoreWriteProperties
Contains properties to set on the table when enabling magnetic store writes. See Magnetic Store Write Properties below for more details.
retentionProperties TableRetentionProperties
The retention duration for the memory store and magnetic store. See Retention Properties below for more details. If not provided, magnetic_store_retention_period_in_days default to 73000 and memory_store_retention_period_in_hours defaults to 6.
schema Changes to this property will trigger replacement. TableSchema
The schema of the table. See Schema below for more details.
tableName Changes to this property will trigger replacement. string
The name of the Timestream table.
tags {[key: string]: string}
Map of tags to assign to this resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
The ARN that uniquely identifies this table.
database_name Changes to this property will trigger replacement. str
The name of the Timestream database.
magnetic_store_write_properties TableMagneticStoreWritePropertiesArgs
Contains properties to set on the table when enabling magnetic store writes. See Magnetic Store Write Properties below for more details.
retention_properties TableRetentionPropertiesArgs
The retention duration for the memory store and magnetic store. See Retention Properties below for more details. If not provided, magnetic_store_retention_period_in_days default to 73000 and memory_store_retention_period_in_hours defaults to 6.
schema Changes to this property will trigger replacement. TableSchemaArgs
The schema of the table. See Schema below for more details.
table_name Changes to this property will trigger replacement. str
The name of the Timestream table.
tags Mapping[str, str]
Map of tags to assign to this resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The ARN that uniquely identifies this table.
databaseName Changes to this property will trigger replacement. String
The name of the Timestream database.
magneticStoreWriteProperties Property Map
Contains properties to set on the table when enabling magnetic store writes. See Magnetic Store Write Properties below for more details.
retentionProperties Property Map
The retention duration for the memory store and magnetic store. See Retention Properties below for more details. If not provided, magnetic_store_retention_period_in_days default to 73000 and memory_store_retention_period_in_hours defaults to 6.
schema Changes to this property will trigger replacement. Property Map
The schema of the table. See Schema below for more details.
tableName Changes to this property will trigger replacement. String
The name of the Timestream table.
tags Map<String>
Map of tags to assign to this resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Supporting Types

TableMagneticStoreWriteProperties
, TableMagneticStoreWritePropertiesArgs

EnableMagneticStoreWrites bool
A flag to enable magnetic store writes.
MagneticStoreRejectedDataLocation TableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocation
The location to write error reports for records rejected asynchronously during magnetic store writes. See Magnetic Store Rejected Data Location below for more details.
EnableMagneticStoreWrites bool
A flag to enable magnetic store writes.
MagneticStoreRejectedDataLocation TableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocation
The location to write error reports for records rejected asynchronously during magnetic store writes. See Magnetic Store Rejected Data Location below for more details.
enableMagneticStoreWrites Boolean
A flag to enable magnetic store writes.
magneticStoreRejectedDataLocation TableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocation
The location to write error reports for records rejected asynchronously during magnetic store writes. See Magnetic Store Rejected Data Location below for more details.
enableMagneticStoreWrites boolean
A flag to enable magnetic store writes.
magneticStoreRejectedDataLocation TableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocation
The location to write error reports for records rejected asynchronously during magnetic store writes. See Magnetic Store Rejected Data Location below for more details.
enable_magnetic_store_writes bool
A flag to enable magnetic store writes.
magnetic_store_rejected_data_location TableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocation
The location to write error reports for records rejected asynchronously during magnetic store writes. See Magnetic Store Rejected Data Location below for more details.
enableMagneticStoreWrites Boolean
A flag to enable magnetic store writes.
magneticStoreRejectedDataLocation Property Map
The location to write error reports for records rejected asynchronously during magnetic store writes. See Magnetic Store Rejected Data Location below for more details.

TableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocation
, TableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationArgs

S3Configuration TableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3Configuration
Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes. See S3 Configuration below for more details.
S3Configuration TableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3Configuration
Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes. See S3 Configuration below for more details.
s3Configuration TableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3Configuration
Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes. See S3 Configuration below for more details.
s3Configuration TableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3Configuration
Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes. See S3 Configuration below for more details.
s3_configuration TableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3Configuration
Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes. See S3 Configuration 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 S3 Configuration below for more details.

TableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3Configuration
, TableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3ConfigurationArgs

BucketName string
Bucket name of the customer S3 bucket.
EncryptionOption 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_KMS and SSE_S3.
KmsKeyId string
KMS key arn for the customer s3 location when encrypting with a KMS managed key.
ObjectKeyPrefix string
Object key prefix for the customer S3 location.
BucketName string
Bucket name of the customer S3 bucket.
EncryptionOption 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_KMS and SSE_S3.
KmsKeyId string
KMS key arn for the customer s3 location when encrypting with a KMS managed key.
ObjectKeyPrefix string
Object key prefix for the customer S3 location.
bucketName String
Bucket name of the customer S3 bucket.
encryptionOption 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_KMS and SSE_S3.
kmsKeyId String
KMS key arn for the customer s3 location when encrypting with a KMS managed key.
objectKeyPrefix String
Object key prefix for the customer S3 location.
bucketName string
Bucket name of the customer S3 bucket.
encryptionOption 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_KMS and SSE_S3.
kmsKeyId string
KMS key arn for the customer s3 location when encrypting with a KMS managed key.
objectKeyPrefix string
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_KMS and SSE_S3.
kms_key_id str
KMS key arn for the customer s3 location when encrypting with a KMS managed key.
object_key_prefix str
Object key prefix for the customer S3 location.
bucketName String
Bucket name of the customer S3 bucket.
encryptionOption 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_KMS and SSE_S3.
kmsKeyId String
KMS key arn for the customer s3 location when encrypting with a KMS managed key.
objectKeyPrefix String
Object key prefix for the customer S3 location.

TableRetentionProperties
, TableRetentionPropertiesArgs

MagneticStoreRetentionPeriodInDays This property is required. int
The duration for which data must be stored in the magnetic store. Minimum value of 1. Maximum value of 73000.
MemoryStoreRetentionPeriodInHours This property is required. int
The duration for which data must be stored in the memory store. Minimum value of 1. Maximum value of 8766.
MagneticStoreRetentionPeriodInDays This property is required. int
The duration for which data must be stored in the magnetic store. Minimum value of 1. Maximum value of 73000.
MemoryStoreRetentionPeriodInHours This property is required. int
The duration for which data must be stored in the memory store. Minimum value of 1. Maximum value of 8766.
magneticStoreRetentionPeriodInDays This property is required. Integer
The duration for which data must be stored in the magnetic store. Minimum value of 1. Maximum value of 73000.
memoryStoreRetentionPeriodInHours This property is required. Integer
The duration for which data must be stored in the memory store. Minimum value of 1. Maximum value of 8766.
magneticStoreRetentionPeriodInDays This property is required. number
The duration for which data must be stored in the magnetic store. Minimum value of 1. Maximum value of 73000.
memoryStoreRetentionPeriodInHours This property is required. number
The duration for which data must be stored in the memory store. Minimum value of 1. Maximum value of 8766.
magnetic_store_retention_period_in_days This property is required. int
The duration for which data must be stored in the magnetic store. Minimum value of 1. Maximum value of 73000.
memory_store_retention_period_in_hours This property is required. int
The duration for which data must be stored in the memory store. Minimum value of 1. Maximum value of 8766.
magneticStoreRetentionPeriodInDays This property is required. Number
The duration for which data must be stored in the magnetic store. Minimum value of 1. Maximum value of 73000.
memoryStoreRetentionPeriodInHours This property is required. Number
The duration for which data must be stored in the memory store. Minimum value of 1. Maximum value of 8766.

TableSchema
, TableSchemaArgs

CompositePartitionKey Changes to this property will trigger replacement. TableSchemaCompositePartitionKey
A 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 Composite Partition Key below for more details.
CompositePartitionKey Changes to this property will trigger replacement. TableSchemaCompositePartitionKey
A 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 Composite Partition Key below for more details.
compositePartitionKey Changes to this property will trigger replacement. TableSchemaCompositePartitionKey
A 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 Composite Partition Key below for more details.
compositePartitionKey Changes to this property will trigger replacement. TableSchemaCompositePartitionKey
A 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 Composite Partition Key below for more details.
composite_partition_key Changes to this property will trigger replacement. TableSchemaCompositePartitionKey
A 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 Composite Partition Key below for more details.
compositePartitionKey Changes to this property will trigger replacement. Property Map
A 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 Composite Partition Key below for more details.

TableSchemaCompositePartitionKey
, TableSchemaCompositePartitionKeyArgs

Type
This property is required.
Changes to this property will trigger replacement.
string
The type of the partition key. Valid values: DIMENSION, MEASURE.
EnforcementInRecord string
The level of enforcement for the specification of a dimension key in ingested records. Valid values: REQUIRED, OPTIONAL.
Name Changes to this property will trigger replacement. string
The name of the attribute used for a dimension key.
Type
This property is required.
Changes to this property will trigger replacement.
string
The type of the partition key. Valid values: DIMENSION, MEASURE.
EnforcementInRecord string
The level of enforcement for the specification of a dimension key in ingested records. Valid values: REQUIRED, OPTIONAL.
Name Changes to this property will trigger replacement. string
The name of the attribute used for a dimension key.
type
This property is required.
Changes to this property will trigger replacement.
String
The type of the partition key. Valid values: DIMENSION, MEASURE.
enforcementInRecord String
The level of enforcement for the specification of a dimension key in ingested records. Valid values: REQUIRED, OPTIONAL.
name Changes to this property will trigger replacement. String
The name of the attribute used for a dimension key.
type
This property is required.
Changes to this property will trigger replacement.
string
The type of the partition key. Valid values: DIMENSION, MEASURE.
enforcementInRecord string
The level of enforcement for the specification of a dimension key in ingested records. Valid values: REQUIRED, OPTIONAL.
name Changes to this property will trigger replacement. string
The name of the attribute used for a dimension key.
type
This property is required.
Changes to this property will trigger replacement.
str
The type of the partition key. Valid values: DIMENSION, MEASURE.
enforcement_in_record str
The level of enforcement for the specification of a dimension key in ingested records. Valid values: REQUIRED, OPTIONAL.
name Changes to this property will trigger replacement. str
The name of the attribute used for a dimension key.
type
This property is required.
Changes to this property will trigger replacement.
String
The type of the partition key. Valid values: DIMENSION, MEASURE.
enforcementInRecord String
The level of enforcement for the specification of a dimension key in ingested records. Valid values: REQUIRED, OPTIONAL.
name Changes to this property will trigger replacement. String
The name of the attribute used for a dimension key.

Import

Using pulumi import, import Timestream tables using the table_name and database_name separate by a colon (:). For example:

$ pulumi import aws:timestreamwrite/table:Table example ExampleTable:ExampleDatabase
Copy

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 aws Terraform Provider.
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws