AWS v6.73.0, Mar 19 25

AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi

aws.timestreamwrite.getTable

Explore with Pulumi AI

AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi

pulumi/pulumi-aws

Example Usage

Basic Usage

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

const test = aws.timestreamwrite.getTable({
    databaseName: testAwsTimestreamwriteDatabase.databaseName,
    name: testAwsTimestreamwriteTable.tableName,
});

import pulumi
import pulumi_aws as aws

test = aws.timestreamwrite.get_table(database_name=test_aws_timestreamwrite_database["databaseName"],
    name=test_aws_timestreamwrite_table["tableName"])

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.LookupTable(ctx, &timestreamwrite.LookupTableArgs{
			DatabaseName: testAwsTimestreamwriteDatabase.DatabaseName,
			Name:         testAwsTimestreamwriteTable.TableName,
		}, nil)
		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 test = Aws.TimestreamWrite.GetTable.Invoke(new()
    {
        DatabaseName = testAwsTimestreamwriteDatabase.DatabaseName,
        Name = testAwsTimestreamwriteTable.TableName,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.timestreamwrite.TimestreamwriteFunctions;
import com.pulumi.aws.timestreamwrite.inputs.GetTableArgs;
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) {
        final var test = TimestreamwriteFunctions.getTable(GetTableArgs.builder()
            .databaseName(testAwsTimestreamwriteDatabase.databaseName())
            .name(testAwsTimestreamwriteTable.tableName())
            .build());

    }
}

variables:
  test:
    fn::invoke:
      function: aws:timestreamwrite:getTable
      arguments:
        databaseName: ${testAwsTimestreamwriteDatabase.databaseName}
        name: ${testAwsTimestreamwriteTable.tableName}

Using getTable

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getTable(args: GetTableArgs, opts?: InvokeOptions): Promise<GetTableResult>
function getTableOutput(args: GetTableOutputArgs, opts?: InvokeOptions): Output<GetTableResult>

def get_table(database_name: Optional[str] = None,
              name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetTableResult
def get_table_output(database_name: Optional[pulumi.Input[str]] = None,
              name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetTableResult]

func LookupTable(ctx *Context, args *LookupTableArgs, opts ...InvokeOption) (*LookupTableResult, error)
func LookupTableOutput(ctx *Context, args *LookupTableOutputArgs, opts ...InvokeOption) LookupTableResultOutput

> Note: This function is named LookupTable in the Go SDK.

public static class GetTable 
{
    public static Task<GetTableResult> InvokeAsync(GetTableArgs args, InvokeOptions? opts = null)
    public static Output<GetTableResult> Invoke(GetTableInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetTableResult> getTable(GetTableArgs args, InvokeOptions options)
public static Output<GetTableResult> getTable(GetTableArgs args, InvokeOptions options)

fn::invoke:
  function: aws:timestreamwrite/getTable:getTable
  arguments:
    # arguments dictionary

The following arguments are supported:

DatabaseName string: Name of the Timestream database.
Name string: Name of the Timestream table.

DatabaseName string: Name of the Timestream database.
Name string: Name of the Timestream table.

databaseName String: Name of the Timestream database.
name String: Name of the Timestream table.

databaseName string: Name of the Timestream database.
name string: Name of the Timestream table.

database_name str: Name of the Timestream database.
name str: Name of the Timestream table.

databaseName String: Name of the Timestream database.
name String: Name of the Timestream table.

getTable Result

The following output properties are available:

Arn string: ARN that uniquely identifies the table.
CreationTime string: Time that table was created.
DatabaseName string: Name of database.
Id string: The provider-assigned unique ID for this managed resource.
LastUpdatedTime string: Last time table was updated.
MagneticStoreWriteProperties List<GetTableMagneticStoreWriteProperty>: Object containing the following attributes to desribe magnetic store writes.
Name string: Name of the table.
RetentionProperties List<GetTableRetentionProperty>: Object containing the following attributes to describe the retention duration for the memory and magnetic stores.
Schemas List<GetTableSchema>: Object containing the following attributes to describe the schema of the table.
TableStatus string: Current state of table.

Arn string: ARN that uniquely identifies the table.
CreationTime string: Time that table was created.
DatabaseName string: Name of database.
Id string: The provider-assigned unique ID for this managed resource.
LastUpdatedTime string: Last time table was updated.
MagneticStoreWriteProperties []GetTableMagneticStoreWriteProperty: Object containing the following attributes to desribe magnetic store writes.
Name string: Name of the table.
RetentionProperties []GetTableRetentionProperty: Object containing the following attributes to describe the retention duration for the memory and magnetic stores.
Schemas []GetTableSchema: Object containing the following attributes to describe the schema of the table.
TableStatus string: Current state of table.

arn String: ARN that uniquely identifies the table.
creationTime String: Time that table was created.
databaseName String: Name of database.
id String: The provider-assigned unique ID for this managed resource.
lastUpdatedTime String: Last time table was updated.
magneticStoreWriteProperties List<GetTableMagneticStoreWriteProperty>: Object containing the following attributes to desribe magnetic store writes.
name String: Name of the table.
retentionProperties List<GetTableRetentionProperty>: Object containing the following attributes to describe the retention duration for the memory and magnetic stores.
schemas List<GetTableSchema>: Object containing the following attributes to describe the schema of the table.
tableStatus String: Current state of table.

arn string: ARN that uniquely identifies the table.
creationTime string: Time that table was created.
databaseName string: Name of database.
id string: The provider-assigned unique ID for this managed resource.
lastUpdatedTime string: Last time table was updated.
magneticStoreWriteProperties GetTableMagneticStoreWriteProperty[]: Object containing the following attributes to desribe magnetic store writes.
name string: Name of the table.
retentionProperties GetTableRetentionProperty[]: Object containing the following attributes to describe the retention duration for the memory and magnetic stores.
schemas GetTableSchema[]: Object containing the following attributes to describe the schema of the table.
tableStatus string: Current state of table.

arn str: ARN that uniquely identifies the table.
creation_time str: Time that table was created.
database_name str: Name of database.
id str: The provider-assigned unique ID for this managed resource.
last_updated_time str: Last time table was updated.
magnetic_store_write_properties Sequence[GetTableMagneticStoreWriteProperty]: Object containing the following attributes to desribe magnetic store writes.
name str: Name of the table.
retention_properties Sequence[GetTableRetentionProperty]: Object containing the following attributes to describe the retention duration for the memory and magnetic stores.
schemas Sequence[GetTableSchema]: Object containing the following attributes to describe the schema of the table.
table_status str: Current state of table.

arn String: ARN that uniquely identifies the table.
creationTime String: Time that table was created.
databaseName String: Name of database.
id String: The provider-assigned unique ID for this managed resource.
lastUpdatedTime String: Last time table was updated.
magneticStoreWriteProperties List<Property Map>: Object containing the following attributes to desribe magnetic store writes.
name String: Name of the table.
retentionProperties List<Property Map>: Object containing the following attributes to describe the retention duration for the memory and magnetic stores.
schemas List<Property Map>: Object containing the following attributes to describe the schema of the table.
tableStatus String: Current state of table.

Supporting Types

GetTableMagneticStoreWriteProperty

EnableMagneticStoreWrites bool: Flag that is set based on if magnetic store writes are enabled.
MagneticStoreRejectedDataLocations List<GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocation>: Object containing the following attributes to describe error reports for records rejected during magnetic store writes.

EnableMagneticStoreWrites bool: Flag that is set based on if magnetic store writes are enabled.
MagneticStoreRejectedDataLocations []GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocation: Object containing the following attributes to describe error reports for records rejected during magnetic store writes.

enableMagneticStoreWrites Boolean: Flag that is set based on if magnetic store writes are enabled.
magneticStoreRejectedDataLocations List<GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocation>: Object containing the following attributes to describe error reports for records rejected during magnetic store writes.

enableMagneticStoreWrites boolean: Flag that is set based on if magnetic store writes are enabled.
magneticStoreRejectedDataLocations GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocation[]: Object containing the following attributes to describe error reports for records rejected during magnetic store writes.

enable_magnetic_store_writes bool: Flag that is set based on if magnetic store writes are enabled.
magnetic_store_rejected_data_locations Sequence[GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocation]: Object containing the following attributes to describe error reports for records rejected during magnetic store writes.

enableMagneticStoreWrites Boolean: Flag that is set based on if magnetic store writes are enabled.
magneticStoreRejectedDataLocations List<Property Map>: Object containing the following attributes to describe error reports for records rejected during magnetic store writes.

GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocation

S3Configurations List<GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocationS3Configuration>: Object containing the following attributes to describe the configuration of an s3 location to write error reports for records rejected.

S3Configurations []GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocationS3Configuration: Object containing the following attributes to describe the configuration of an s3 location to write error reports for records rejected.

s3Configurations List<GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocationS3Configuration>: Object containing the following attributes to describe the configuration of an s3 location to write error reports for records rejected.

s3Configurations GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocationS3Configuration[]: Object containing the following attributes to describe the configuration of an s3 location to write error reports for records rejected.

s3_configurations Sequence[GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocationS3Configuration]: Object containing the following attributes to describe the configuration of an s3 location to write error reports for records rejected.

s3Configurations List<Property Map>: Object containing the following attributes to describe the configuration of an s3 location to write error reports for records rejected.

GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocationS3Configuration

BucketName string: Name of S3 bucket.
EncryptionOption string
KmsKeyId string: AWS KMS key ID for S3 location with AWS maanged key.
ObjectKeyPrefix string: Object key preview for S3 location.

BucketName string: Name of S3 bucket.
EncryptionOption string
KmsKeyId string: AWS KMS key ID for S3 location with AWS maanged key.
ObjectKeyPrefix string: Object key preview for S3 location.

bucketName String: Name of S3 bucket.
encryptionOption String
kmsKeyId String: AWS KMS key ID for S3 location with AWS maanged key.
objectKeyPrefix String: Object key preview for S3 location.

bucketName string: Name of S3 bucket.
encryptionOption string
kmsKeyId string: AWS KMS key ID for S3 location with AWS maanged key.
objectKeyPrefix string: Object key preview for S3 location.

bucket_name str: Name of S3 bucket.
encryption_option str
kms_key_id str: AWS KMS key ID for S3 location with AWS maanged key.
object_key_prefix str: Object key preview for S3 location.

bucketName String: Name of S3 bucket.
encryptionOption String
kmsKeyId String: AWS KMS key ID for S3 location with AWS maanged key.
objectKeyPrefix String: Object key preview for S3 location.

GetTableRetentionProperty

MagneticStoreRetentionPeriodInDays int: Duration in days in which the data must be stored in magnetic store.
MemoryStoreRetentionPeriodInHours int: Duration in hours in which the data must be stored in memory store.

MagneticStoreRetentionPeriodInDays int: Duration in days in which the data must be stored in magnetic store.
MemoryStoreRetentionPeriodInHours int: Duration in hours in which the data must be stored in memory store.

magneticStoreRetentionPeriodInDays Integer: Duration in days in which the data must be stored in magnetic store.
memoryStoreRetentionPeriodInHours Integer: Duration in hours in which the data must be stored in memory store.

magneticStoreRetentionPeriodInDays number: Duration in days in which the data must be stored in magnetic store.
memoryStoreRetentionPeriodInHours number: Duration in hours in which the data must be stored in memory store.

magnetic_store_retention_period_in_days int: Duration in days in which the data must be stored in magnetic store.
memory_store_retention_period_in_hours int: Duration in hours in which the data must be stored in memory store.

magneticStoreRetentionPeriodInDays Number: Duration in days in which the data must be stored in magnetic store.
memoryStoreRetentionPeriodInHours Number: Duration in hours in which the data must be stored in memory store.