CfnTableProps

class aws_cdk.aws_timestream.CfnTableProps(*, database_name, magnetic_store_write_properties=None, retention_properties=None, table_name=None, tags=None)

Bases: object

Properties for defining a CfnTable.

Parameters
  • database_name (str) – The name of the Timestream database that contains this table. Length Constraints : Minimum length of 3 bytes. Maximum length of 256 bytes.

  • magnetic_store_write_properties (Optional[Any]) – Contains properties to set on the table when enabling magnetic store writes. This object has the following attributes: - EnableMagneticStoreWrites : A boolean flag to enable magnetic store writes. - MagneticStoreRejectedDataLocation : The location to write error reports for records rejected, asynchronously, during magnetic store writes. Only S3Configuration objects are allowed. The S3Configuration object has the following attributes: - BucketName : The name of the S3 bucket. - EncryptionOption : The encryption option for the S3 location. Valid values are S3 server-side encryption with an S3 managed key ( SSE_S3 ) or AWS managed key ( SSE_KMS ). - KmsKeyId : The AWS KMS key ID to use when encrypting with an AWS managed key. - ObjectKeyPrefix : The prefix to use option for the objects stored in S3. Both BucketName and EncryptionOption are required when S3Configuration is specified. If you specify SSE_KMS as your EncryptionOption then KmsKeyId is required . EnableMagneticStoreWrites attribute is required when MagneticStoreWriteProperties is specified. MagneticStoreRejectedDataLocation attribute is required when EnableMagneticStoreWrites is set to true . See the following examples: *JSON:: { “Type” : AWS::Timestream::Table”, “Properties”:{ “DatabaseName”:”TestDatabase”, “TableName”:”TestTable”, “MagneticStoreWriteProperties”:{ “EnableMagneticStoreWrites”:true, “MagneticStoreRejectedDataLocation”:{ “S3Configuration”:{ “BucketName”:”testbucket”, “EncryptionOption”:”SSE_KMS”, “KmsKeyId”:”1234abcd-12ab-34cd-56ef-1234567890ab”, “ObjectKeyPrefix”:”prefix” } } } } } *YAML:: Type: AWS::Timestream::Table DependsOn: TestDatabase Properties: TableName: “TestTable” DatabaseName: “TestDatabase” MagneticStoreWriteProperties: EnableMagneticStoreWrites: true MagneticStoreRejectedDataLocation: S3Configuration: BucketName: “testbucket” EncryptionOption: “SSE_KMS” BucketName: “1234abcd-12ab-34cd-56ef-1234567890ab” EncryptionOption: “prefix”

  • retention_properties (Optional[Any]) – The retention duration for the memory store and magnetic store. This object has the following attributes:. - MemoryStoreRetentionPeriodInHours : Retention duration for memory store, in hours. - MagneticStoreRetentionPeriodInDays : Retention duration for magnetic store, in days. Both attributes are of type string . Both attributes are required when RetentionProperties is specified. See the following examples: JSON { "Type" : AWS::Timestream::Table", "Properties" : { "DatabaseName" : "TestDatabase", "TableName" : "TestTable", "RetentionProperties" : { "MemoryStoreRetentionPeriodInHours": "24", "MagneticStoreRetentionPeriodInDays": "7" } } } *YAML:: Type: AWS::Timestream::Table DependsOn: TestDatabase Properties: TableName: “TestTable” DatabaseName: “TestDatabase” RetentionProperties: MemoryStoreRetentionPeriodInHours: “24” MagneticStoreRetentionPeriodInDays: “7”

  • table_name (Optional[str]) – The name of the Timestream table. Length Constraints : Minimum length of 3 bytes. Maximum length of 256 bytes.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags to add to the table.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_timestream as timestream

# magnetic_store_write_properties: Any
# retention_properties: Any

cfn_table_props = timestream.CfnTableProps(
    database_name="databaseName",

    # the properties below are optional
    magnetic_store_write_properties=magnetic_store_write_properties,
    retention_properties=retention_properties,
    table_name="tableName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

database_name

The name of the Timestream database that contains this table.

Length Constraints : Minimum length of 3 bytes. Maximum length of 256 bytes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-databasename

Return type

str

magnetic_store_write_properties

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

This object has the following attributes:

  • EnableMagneticStoreWrites : A boolean flag to enable magnetic store writes.

  • MagneticStoreRejectedDataLocation : The location to write error reports for records rejected, asynchronously, during magnetic store writes. Only S3Configuration objects are allowed. The S3Configuration object has the following attributes:

  • BucketName : The name of the S3 bucket.

  • EncryptionOption : The encryption option for the S3 location. Valid values are S3 server-side encryption with an S3 managed key ( SSE_S3 ) or AWS managed key ( SSE_KMS ).

  • KmsKeyId : The AWS KMS key ID to use when encrypting with an AWS managed key.

  • ObjectKeyPrefix : The prefix to use option for the objects stored in S3.

Both BucketName and EncryptionOption are required when S3Configuration is specified. If you specify SSE_KMS as your EncryptionOption then KmsKeyId is required .

EnableMagneticStoreWrites attribute is required when MagneticStoreWriteProperties is specified. MagneticStoreRejectedDataLocation attribute is required when EnableMagneticStoreWrites is set to true .

See the following examples:

*JSON:

{ "Type" : AWS::Timestream::Table", "Properties":{ "DatabaseName":"TestDatabase", "TableName":"TestTable", "MagneticStoreWriteProperties":{ "EnableMagneticStoreWrites":true, "MagneticStoreRejectedDataLocation":{ "S3Configuration":{ "BucketName":"testbucket", "EncryptionOption":"SSE_KMS", "KmsKeyId":"1234abcd-12ab-34cd-56ef-1234567890ab", "ObjectKeyPrefix":"prefix" } } } }
}

*YAML:

Type: AWS::Timestream::Table
DependsOn: TestDatabase
Properties: TableName: "TestTable" DatabaseName: "TestDatabase" MagneticStoreWriteProperties: EnableMagneticStoreWrites: true MagneticStoreRejectedDataLocation: S3Configuration: BucketName: "testbucket" EncryptionOption: "SSE_KMS" BucketName: "1234abcd-12ab-34cd-56ef-1234567890ab" EncryptionOption: "prefix"
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-magneticstorewriteproperties

Return type

Any

retention_properties

.

  • MemoryStoreRetentionPeriodInHours : Retention duration for memory store, in hours.

  • MagneticStoreRetentionPeriodInDays : Retention duration for magnetic store, in days.

Both attributes are of type string . Both attributes are required when RetentionProperties is specified.

See the following examples:

JSON

{ "Type" : AWS::Timestream::Table", "Properties" : { "DatabaseName" : "TestDatabase", "TableName" : "TestTable", "RetentionProperties" : { "MemoryStoreRetentionPeriodInHours": "24", "MagneticStoreRetentionPeriodInDays": "7" } } }

*YAML:

Type: AWS::Timestream::Table
DependsOn: TestDatabase
Properties: TableName: "TestTable" DatabaseName: "TestDatabase" RetentionProperties: MemoryStoreRetentionPeriodInHours: "24" MagneticStoreRetentionPeriodInDays: "7"
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-retentionproperties

Type

The retention duration for the memory store and magnetic store. This object has the following attributes

Return type

Any

table_name

The name of the Timestream table.

Length Constraints : Minimum length of 3 bytes. Maximum length of 256 bytes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-tablename

Return type

Optional[str]

tags

The tags to add to the table.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-tags

Return type

Optional[List[CfnTag]]