Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. timestream
  5. Table

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.timestream.Table

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

The AWS::Timestream::Table resource creates a Timestream Table.

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,
          magnetic_store_write_properties: Optional[MagneticStoreWritePropertiesPropertiesArgs] = None,
          retention_properties: Optional[RetentionPropertiesPropertiesArgs] = None,
          schema: Optional[SchemaPropertiesArgs] = None,
          table_name: Optional[str] = None,
          tags: Optional[Sequence[_root_inputs.TagArgs]] = 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-native:timestream: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.

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. string
The name for the database which the table to be created belongs to.
MagneticStoreWriteProperties Pulumi.AwsNative.Timestream.Inputs.MagneticStoreWritePropertiesProperties
The properties that determine whether magnetic store writes are enabled.
RetentionProperties Pulumi.AwsNative.Timestream.Inputs.RetentionPropertiesProperties
The retention duration of the memory store and the magnetic store.
Schema Pulumi.AwsNative.Timestream.Inputs.SchemaProperties
A Schema specifies the expected data model of the table.
TableName string
The name for the table. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name.
Tags List<Pulumi.AwsNative.Inputs.Tag>
An array of key-value pairs to apply to this resource.
DatabaseName This property is required. string
The name for the database which the table to be created belongs to.
MagneticStoreWriteProperties MagneticStoreWritePropertiesPropertiesArgs
The properties that determine whether magnetic store writes are enabled.
RetentionProperties RetentionPropertiesPropertiesArgs
The retention duration of the memory store and the magnetic store.
Schema SchemaPropertiesArgs
A Schema specifies the expected data model of the table.
TableName string
The name for the table. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name.
Tags TagArgs
An array of key-value pairs to apply to this resource.
databaseName This property is required. String
The name for the database which the table to be created belongs to.
magneticStoreWriteProperties MagneticStoreWritePropertiesProperties
The properties that determine whether magnetic store writes are enabled.
retentionProperties RetentionPropertiesProperties
The retention duration of the memory store and the magnetic store.
schema SchemaProperties
A Schema specifies the expected data model of the table.
tableName String
The name for the table. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name.
tags List<Tag>
An array of key-value pairs to apply to this resource.
databaseName This property is required. string
The name for the database which the table to be created belongs to.
magneticStoreWriteProperties MagneticStoreWritePropertiesProperties
The properties that determine whether magnetic store writes are enabled.
retentionProperties RetentionPropertiesProperties
The retention duration of the memory store and the magnetic store.
schema SchemaProperties
A Schema specifies the expected data model of the table.
tableName string
The name for the table. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name.
tags Tag[]
An array of key-value pairs to apply to this resource.
database_name This property is required. str
The name for the database which the table to be created belongs to.
magnetic_store_write_properties MagneticStoreWritePropertiesPropertiesArgs
The properties that determine whether magnetic store writes are enabled.
retention_properties RetentionPropertiesPropertiesArgs
The retention duration of the memory store and the magnetic store.
schema SchemaPropertiesArgs
A Schema specifies the expected data model of the table.
table_name str
The name for the table. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name.
tags Sequence[TagArgs]
An array of key-value pairs to apply to this resource.
databaseName This property is required. String
The name for the database which the table to be created belongs to.
magneticStoreWriteProperties Property Map
The properties that determine whether magnetic store writes are enabled.
retentionProperties Property Map
The retention duration of the memory store and the magnetic store.
schema Property Map
A Schema specifies the expected data model of the table.
tableName String
The name for the table. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name.
tags List<Property Map>
An array of key-value pairs to apply to this resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Table resource produces the following output properties:

Arn string
The arn of the table.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The table name exposed as a read-only attribute.
Arn string
The arn of the table.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The table name exposed as a read-only attribute.
arn String
The arn of the table.
id String
The provider-assigned unique ID for this managed resource.
name String
The table name exposed as a read-only attribute.
arn string
The arn of the table.
id string
The provider-assigned unique ID for this managed resource.
name string
The table name exposed as a read-only attribute.
arn str
The arn of the table.
id str
The provider-assigned unique ID for this managed resource.
name str
The table name exposed as a read-only attribute.
arn String
The arn of the table.
id String
The provider-assigned unique ID for this managed resource.
name String
The table name exposed as a read-only attribute.

Supporting Types

MagneticStoreWritePropertiesProperties
, MagneticStoreWritePropertiesPropertiesArgs

EnableMagneticStoreWrites This property is required. bool
Boolean flag indicating whether magnetic store writes are enabled.
MagneticStoreRejectedDataLocation Pulumi.AwsNative.Timestream.Inputs.MagneticStoreWritePropertiesPropertiesMagneticStoreRejectedDataLocationProperties
Location to store information about records that were asynchronously rejected during magnetic store writes.
EnableMagneticStoreWrites This property is required. bool
Boolean flag indicating whether magnetic store writes are enabled.
MagneticStoreRejectedDataLocation MagneticStoreWritePropertiesPropertiesMagneticStoreRejectedDataLocationProperties
Location to store information about records that were asynchronously rejected during magnetic store writes.
enableMagneticStoreWrites This property is required. Boolean
Boolean flag indicating whether magnetic store writes are enabled.
magneticStoreRejectedDataLocation MagneticStoreWritePropertiesPropertiesMagneticStoreRejectedDataLocationProperties
Location to store information about records that were asynchronously rejected during magnetic store writes.
enableMagneticStoreWrites This property is required. boolean
Boolean flag indicating whether magnetic store writes are enabled.
magneticStoreRejectedDataLocation MagneticStoreWritePropertiesPropertiesMagneticStoreRejectedDataLocationProperties
Location to store information about records that were asynchronously rejected during magnetic store writes.
enable_magnetic_store_writes This property is required. bool
Boolean flag indicating whether magnetic store writes are enabled.
magnetic_store_rejected_data_location MagneticStoreWritePropertiesPropertiesMagneticStoreRejectedDataLocationProperties
Location to store information about records that were asynchronously rejected during magnetic store writes.
enableMagneticStoreWrites This property is required. Boolean
Boolean flag indicating whether magnetic store writes are enabled.
magneticStoreRejectedDataLocation Property Map
Location to store information about records that were asynchronously rejected during magnetic store writes.

MagneticStoreWritePropertiesPropertiesMagneticStoreRejectedDataLocationProperties
, MagneticStoreWritePropertiesPropertiesMagneticStoreRejectedDataLocationPropertiesArgs

s3Configuration Property Map
S3 configuration for location to store rejections from magnetic store writes

MagneticStoreWritePropertiesPropertiesMagneticStoreRejectedDataLocationPropertiesS3ConfigurationProperties
, MagneticStoreWritePropertiesPropertiesMagneticStoreRejectedDataLocationPropertiesS3ConfigurationPropertiesArgs

BucketName This property is required. string
The bucket name used to store the data.
EncryptionOption This property is required. string
Either SSE_KMS or SSE_S3.
KmsKeyId string
Must be provided if SSE_KMS is specified as the encryption option
ObjectKeyPrefix string
String used to prefix all data in the bucket.
BucketName This property is required. string
The bucket name used to store the data.
EncryptionOption This property is required. string
Either SSE_KMS or SSE_S3.
KmsKeyId string
Must be provided if SSE_KMS is specified as the encryption option
ObjectKeyPrefix string
String used to prefix all data in the bucket.
bucketName This property is required. String
The bucket name used to store the data.
encryptionOption This property is required. String
Either SSE_KMS or SSE_S3.
kmsKeyId String
Must be provided if SSE_KMS is specified as the encryption option
objectKeyPrefix String
String used to prefix all data in the bucket.
bucketName This property is required. string
The bucket name used to store the data.
encryptionOption This property is required. string
Either SSE_KMS or SSE_S3.
kmsKeyId string
Must be provided if SSE_KMS is specified as the encryption option
objectKeyPrefix string
String used to prefix all data in the bucket.
bucket_name This property is required. str
The bucket name used to store the data.
encryption_option This property is required. str
Either SSE_KMS or SSE_S3.
kms_key_id str
Must be provided if SSE_KMS is specified as the encryption option
object_key_prefix str
String used to prefix all data in the bucket.
bucketName This property is required. String
The bucket name used to store the data.
encryptionOption This property is required. String
Either SSE_KMS or SSE_S3.
kmsKeyId String
Must be provided if SSE_KMS is specified as the encryption option
objectKeyPrefix String
String used to prefix all data in the bucket.

RetentionPropertiesProperties
, RetentionPropertiesPropertiesArgs

MagneticStoreRetentionPeriodInDays string
The duration for which data must be stored in the magnetic store.
MemoryStoreRetentionPeriodInHours string
The duration for which data must be stored in the memory store.
MagneticStoreRetentionPeriodInDays string
The duration for which data must be stored in the magnetic store.
MemoryStoreRetentionPeriodInHours string
The duration for which data must be stored in the memory store.
magneticStoreRetentionPeriodInDays String
The duration for which data must be stored in the magnetic store.
memoryStoreRetentionPeriodInHours String
The duration for which data must be stored in the memory store.
magneticStoreRetentionPeriodInDays string
The duration for which data must be stored in the magnetic store.
memoryStoreRetentionPeriodInHours string
The duration for which data must be stored in the memory store.
magnetic_store_retention_period_in_days str
The duration for which data must be stored in the magnetic store.
memory_store_retention_period_in_hours str
The duration for which data must be stored in the memory store.
magneticStoreRetentionPeriodInDays String
The duration for which data must be stored in the magnetic store.
memoryStoreRetentionPeriodInHours String
The duration for which data must be stored in the memory store.

SchemaProperties
, SchemaPropertiesArgs

CompositePartitionKey List<Pulumi.AwsNative.Timestream.Inputs.TablePartitionKey>
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.
CompositePartitionKey []TablePartitionKey
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.
compositePartitionKey List<TablePartitionKey>
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.
compositePartitionKey TablePartitionKey[]
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.
composite_partition_key Sequence[TablePartitionKey]
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.
compositePartitionKey List<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.

TablePartitionKey
, TablePartitionKeyArgs

TablePartitionKeyEnforcementLevel
, TablePartitionKeyEnforcementLevelArgs

Required
REQUIRED
Optional
OPTIONAL
TablePartitionKeyEnforcementLevelRequired
REQUIRED
TablePartitionKeyEnforcementLevelOptional
OPTIONAL
Required
REQUIRED
Optional
OPTIONAL
Required
REQUIRED
Optional
OPTIONAL
REQUIRED
REQUIRED
OPTIONAL
OPTIONAL
"REQUIRED"
REQUIRED
"OPTIONAL"
OPTIONAL

TablePartitionKeyType
, TablePartitionKeyTypeArgs

Dimension
DIMENSION
Measure
MEASURE
TablePartitionKeyTypeDimension
DIMENSION
TablePartitionKeyTypeMeasure
MEASURE
Dimension
DIMENSION
Measure
MEASURE
Dimension
DIMENSION
Measure
MEASURE
DIMENSION
DIMENSION
MEASURE
MEASURE
"DIMENSION"
DIMENSION
"MEASURE"
MEASURE

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native