Class CfnTableMixinProps

Properties for CfnTablePropsMixin.

Inheritance

object

CfnTableMixinProps

Implements

ICfnTableMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.Timestream.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnTableMixinProps : ICfnTableMixinProps

Syntax (vb)

Public Class CfnTableMixinProps Implements ICfnTableMixinProps

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.Mixins.Preview.AWS.Timestream.Mixins;

             var magneticStoreWriteProperties;
             var retentionProperties;

             var cfnTableMixinProps = new CfnTableMixinProps {
                 DatabaseName = "databaseName",
                 MagneticStoreWriteProperties = magneticStoreWriteProperties,
                 RetentionProperties = retentionProperties,
                 Schema = new SchemaProperty {
                     CompositePartitionKey = new [] { new PartitionKeyProperty {
                         EnforcementInRecord = "enforcementInRecord",
                         Name = "name",
                         Type = "type"
                     } }
                 },
                 TableName = "tableName",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnTableMixinProps()

Properties for CfnTablePropsMixin.

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.

Constructors

CfnTableMixinProps()

Properties for CfnTablePropsMixin.

public CfnTableMixinProps()

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.Mixins.Preview.AWS.Timestream.Mixins;

             var magneticStoreWriteProperties;
             var retentionProperties;

             var cfnTableMixinProps = new CfnTableMixinProps {
                 DatabaseName = "databaseName",
                 MagneticStoreWriteProperties = magneticStoreWriteProperties,
                 RetentionProperties = retentionProperties,
                 Schema = new SchemaProperty {
                     CompositePartitionKey = new [] { new PartitionKeyProperty {
                         EnforcementInRecord = "enforcementInRecord",
                         Name = "name",
                         Type = "type"
                     } }
                 },
                 TableName = "tableName",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

DatabaseName

The name of the Timestream database that contains this table.

public string? DatabaseName { get; set; }

Property Value

string

Remarks

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

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

MagneticStoreWriteProperties

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

public object? MagneticStoreWriteProperties { get; set; }

Property Value

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":" amzn-s3-demo-bucket ", "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: " amzn-s3-demo-bucket " EncryptionOption: "SSE_KMS" KmsKeyId: "1234abcd-12ab-34cd-56ef-1234567890ab" ObjectKeyPrefix: "prefix"

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

RetentionProperties

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

public object? RetentionProperties { get; set; }

Property Value

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"

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

Schema

The schema of the table.

public object? Schema { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnTablePropsMixin.ISchemaProperty

TableName

The name of the Timestream table.

public string? TableName { get; set; }

Property Value

string

Remarks

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

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

Implements

ICfnTableMixinProps