1. Packages
  2. AWS Native
  3. API Docs
  4. timestream
  5. Table

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

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

aws-native.timestream.Table

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

    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 string
    The unique name of the resource.
    args TableArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args TableArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args TableArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TableArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TableArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const exampletableResourceResourceFromTimestream = new aws_native.timestream.Table("exampletableResourceResourceFromTimestream", {
        databaseName: "string",
        magneticStoreWriteProperties: {
            enableMagneticStoreWrites: false,
            magneticStoreRejectedDataLocation: {
                s3Configuration: {
                    bucketName: "string",
                    encryptionOption: "string",
                    kmsKeyId: "string",
                    objectKeyPrefix: "string",
                },
            },
        },
        retentionProperties: {
            magneticStoreRetentionPeriodInDays: "string",
            memoryStoreRetentionPeriodInHours: "string",
        },
        schema: {
            compositePartitionKey: [{
                type: aws_native.timestream.TablePartitionKeyType.Dimension,
                enforcementInRecord: aws_native.timestream.TablePartitionKeyEnforcementLevel.Required,
                name: "string",
            }],
        },
        tableName: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    Coming soon!
    

    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

    The Table resource accepts the following input properties:

    DatabaseName 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 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 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 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 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 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
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The table name exposed as a read-only attribute.
    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The table name exposed as a read-only attribute.
    arn String
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The table name exposed as a read-only attribute.
    arn string
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The table name exposed as a read-only attribute.
    arn str
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The table name exposed as a read-only attribute.
    arn String
    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 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, MagneticStoreWritePropertiesPropertiesMagneticStoreRejectedDataLocationPropertiesArgs

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

    MagneticStoreWritePropertiesPropertiesMagneticStoreRejectedDataLocationPropertiesS3ConfigurationProperties, MagneticStoreWritePropertiesPropertiesMagneticStoreRejectedDataLocationPropertiesS3ConfigurationPropertiesArgs

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

    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 string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

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

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi