AWS Native v0.109.0, Jun 26 24

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.timestream.getTable

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi

pulumi/pulumi-aws-native

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,
              table_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetTableResult
def get_table_output(database_name: Optional[pulumi.Input[str]] = None,
              table_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)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:timestream:getTable
  arguments:
    # arguments dictionary

The following arguments are supported:

DatabaseName string: The name for the database which the table to be created belongs to.
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.

DatabaseName string: The name for the database which the table to be created belongs to.
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.

databaseName String: The name for the database which the table to be created belongs to.
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.

databaseName string: The name for the database which the table to be created belongs to.
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.

database_name str: The name for the database which the table to be created belongs to.
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.

databaseName String: The name for the database which the table to be created belongs to.
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.

getTable Result

The following output properties are available:

Arn string: The arn of the table.
MagneticStoreWriteProperties Pulumi.AwsNative.Timestream.Outputs.MagneticStoreWritePropertiesProperties: The properties that determine whether magnetic store writes are enabled.
Name string: The table name exposed as a read-only attribute.
RetentionProperties Pulumi.AwsNative.Timestream.Outputs.RetentionPropertiesProperties: The retention duration of the memory store and the magnetic store.
Schema Pulumi.AwsNative.Timestream.Outputs.SchemaProperties: A Schema specifies the expected data model of the table.
Tags List<Pulumi.AwsNative.Outputs.Tag>: An array of key-value pairs to apply to this resource.

Arn string: The arn of the table.
MagneticStoreWriteProperties MagneticStoreWritePropertiesProperties: The properties that determine whether magnetic store writes are enabled.
Name string: The table name exposed as a read-only attribute.
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.
Tags Tag: An array of key-value pairs to apply to this resource.

arn String: The arn of the table.
magneticStoreWriteProperties MagneticStoreWritePropertiesProperties: The properties that determine whether magnetic store writes are enabled.
name String: The table name exposed as a read-only attribute.
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.
tags List<Tag>: An array of key-value pairs to apply to this resource.

arn string: The arn of the table.
magneticStoreWriteProperties MagneticStoreWritePropertiesProperties: The properties that determine whether magnetic store writes are enabled.
name string: The table name exposed as a read-only attribute.
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.
tags Tag[]: An array of key-value pairs to apply to this resource.

arn str: The arn of the table.
magnetic_store_write_properties MagneticStoreWritePropertiesProperties: The properties that determine whether magnetic store writes are enabled.
name str: The table name exposed as a read-only attribute.
retention_properties RetentionPropertiesProperties: The retention duration of the memory store and the magnetic store.
schema SchemaProperties: A Schema specifies the expected data model of the table.
tags Sequence[root_Tag]: An array of key-value pairs to apply to this resource.

arn String: The arn of the table.
magneticStoreWriteProperties Property Map: The properties that determine whether magnetic store writes are enabled.
name String: The table name exposed as a read-only attribute.
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.
tags List<Property Map>: An array of key-value pairs to apply to this resource.

Supporting Types

MagneticStoreWritePropertiesProperties

EnableMagneticStoreWrites 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 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 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 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 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 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

S3Configuration Pulumi.AwsNative.Timestream.Inputs.MagneticStoreWritePropertiesPropertiesMagneticStoreRejectedDataLocationPropertiesS3ConfigurationProperties: S3 configuration for location to store rejections from magnetic store writes

S3Configuration MagneticStoreWritePropertiesPropertiesMagneticStoreRejectedDataLocationPropertiesS3ConfigurationProperties: S3 configuration for location to store rejections from magnetic store writes

s3Configuration MagneticStoreWritePropertiesPropertiesMagneticStoreRejectedDataLocationPropertiesS3ConfigurationProperties: S3 configuration for location to store rejections from magnetic store writes

s3Configuration MagneticStoreWritePropertiesPropertiesMagneticStoreRejectedDataLocationPropertiesS3ConfigurationProperties: S3 configuration for location to store rejections from magnetic store writes

s3_configuration MagneticStoreWritePropertiesPropertiesMagneticStoreRejectedDataLocationPropertiesS3ConfigurationProperties: S3 configuration for location to store rejections from magnetic store writes

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

MagneticStoreWritePropertiesPropertiesMagneticStoreRejectedDataLocationPropertiesS3ConfigurationProperties

BucketName string: The bucket name used to store the data.
EncryptionOption 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 string: The bucket name used to store the data.
EncryptionOption 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 String: The bucket name used to store the data.
encryptionOption 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 string: The bucket name used to store the data.
encryptionOption 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 str: The bucket name used to store the data.
encryption_option 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 String: The bucket name used to store the data.
encryptionOption 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

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

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.