Class: Aws::TimestreamWrite::Types::CreateTableRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-timestreamwrite/types.rb

Overview

Note:

When making an API call, you may pass CreateTableRequest data as a hash:

{
  database_name: "ResourceCreateAPIName", # required
  table_name: "ResourceCreateAPIName", # required
  retention_properties: {
    memory_store_retention_period_in_hours: 1, # required
    magnetic_store_retention_period_in_days: 1, # required
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  magnetic_store_write_properties: {
    enable_magnetic_store_writes: false, # required
    magnetic_store_rejected_data_location: {
      s3_configuration: {
        bucket_name: "S3BucketName",
        object_key_prefix: "S3ObjectKeyPrefix",
        encryption_option: "SSE_S3", # accepts SSE_S3, SSE_KMS
        kms_key_id: "StringValue2048",
      },
    },
  },
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#database_name ⇒ String

The name of the Timestream database.

Returns:

  • (String) 


148
149
150
151
152
153
154
155
156
 
# File 'lib/aws-sdk-timestreamwrite/types.rb', line 148

class CreateTableRequest < Struct.new(
  :database_name,
  :table_name,
  :retention_properties,
  :tags,
  :magnetic_store_write_properties)
  SENSITIVE = []
  include Aws::Structure
end

#magnetic_store_write_properties ⇒ Types::MagneticStoreWriteProperties

Contains properties to set on the table when enabling magnetic store writes.

Returns:



148
149
150
151
152
153
154
155
156
 
# File 'lib/aws-sdk-timestreamwrite/types.rb', line 148

class CreateTableRequest < Struct.new(
  :database_name,
  :table_name,
  :retention_properties,
  :tags,
  :magnetic_store_write_properties)
  SENSITIVE = []
  include Aws::Structure
end

#retention_properties ⇒ Types::RetentionProperties

The duration for which your time series data must be stored in the memory store and the magnetic store.

Returns:



148
149
150
151
152
153
154
155
156
 
# File 'lib/aws-sdk-timestreamwrite/types.rb', line 148

class CreateTableRequest < Struct.new(
  :database_name,
  :table_name,
  :retention_properties,
  :tags,
  :magnetic_store_write_properties)
  SENSITIVE = []
  include Aws::Structure
end

#table_name ⇒ String

The name of the Timestream table.

Returns:

  • (String) 


148
149
150
151
152
153
154
155
156
 
# File 'lib/aws-sdk-timestreamwrite/types.rb', line 148

class CreateTableRequest < Struct.new(
  :database_name,
  :table_name,
  :retention_properties,
  :tags,
  :magnetic_store_write_properties)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of key-value pairs to label the table.

Returns:



148
149
150
151
152
153
154
155
156
 
# File 'lib/aws-sdk-timestreamwrite/types.rb', line 148

class CreateTableRequest < Struct.new(
  :database_name,
  :table_name,
  :retention_properties,
  :tags,
  :magnetic_store_write_properties)
  SENSITIVE = []
  include Aws::Structure
end