Interface ICfnTableProps
Properties for defining a CfnTable
.
Namespace: Amazon.CDK.AWS.Timestream
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnTableProps
Syntax (vb)
Public Interface ICfnTableProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Timestream;
var magneticStoreWriteProperties;
var retentionProperties;
var cfnTableProps = new CfnTableProps {
DatabaseName = "databaseName",
// the properties below are optional
MagneticStoreWriteProperties = magneticStoreWriteProperties,
RetentionProperties = retentionProperties,
Schema = new SchemaProperty {
CompositePartitionKey = new [] { new PartitionKeyProperty {
Type = "type",
// the properties below are optional
EnforcementInRecord = "enforcementInRecord",
Name = "name"
} }
},
TableName = "tableName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Properties
DatabaseName | The name of the Timestream database that contains this table. |
MagneticStoreWriteProperties | Contains properties to set on the table when enabling magnetic store writes. |
RetentionProperties | The retention duration for the memory store and magnetic store. This object has the following attributes:. |
Schema | The schema of the table. |
TableName | The name of the Timestream table. |
Tags | The tags to add to the table. |
Properties
DatabaseName
The name of the Timestream database that contains this table.
string DatabaseName { get; }
Property Value
System.String
Remarks
Length Constraints : Minimum length of 3 bytes. Maximum length of 256 bytes.
MagneticStoreWriteProperties
Contains properties to set on the table when enabling magnetic store writes.
virtual object MagneticStoreWriteProperties { get; }
Property Value
System.Object
Remarks
This object has the following attributes:
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" KmsKeyId: "1234abcd-12ab-34cd-56ef-1234567890ab" ObjectKeyPrefix: "prefix"
RetentionProperties
The retention duration for the memory store and magnetic store. This object has the following attributes:.
virtual object RetentionProperties { get; }
Property Value
System.Object
Remarks
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"
Schema
The schema of the table.
virtual object Schema { get; }
Property Value
System.Object
Remarks
TableName
The name of the Timestream table.
virtual string TableName { get; }
Property Value
System.String
Remarks
Length Constraints : Minimum length of 3 bytes. Maximum length of 256 bytes.