CfnTablePropsMixin

class aws_cdk.mixins_preview.aws_timestream.mixins.CfnTablePropsMixin(props, *, strategy=None)

Bases: Mixin

The CreateTable operation adds a new table to an existing database in your account.

In an AWS account, table names must be at least unique within each Region if they are in the same database. You may have identical table names in the same Region if the tables are in separate databases. While creating the table, you must specify the table name, database name, and the retention properties. Service quotas apply . See code sample for details.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html
CloudformationResource:: AWS::Timestream::Table
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

# magnetic_store_write_properties: Any
# retention_properties: Any

cfn_table_props_mixin = timestream_mixins.CfnTablePropsMixin(timestream_mixins.CfnTableMixinProps(
    database_name="databaseName",
    magnetic_store_write_properties=magnetic_store_write_properties,
    retention_properties=retention_properties,
    schema=timestream_mixins.CfnTablePropsMixin.SchemaProperty(
        composite_partition_key=[timestream_mixins.CfnTablePropsMixin.PartitionKeyProperty(
            enforcement_in_record="enforcementInRecord",
            name="name",
            type="type"
        )]
    ),
    table_name="tableName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Timestream::Table.

Parameters:

props (Union[CfnTableMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['databaseName', 'magneticStoreWriteProperties', 'retentionProperties', 'schema', 'tableName', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

MagneticStoreRejectedDataLocationProperty

class CfnTablePropsMixin.MagneticStoreRejectedDataLocationProperty(*, s3_configuration=None)

Bases: object

The location to write error reports for records rejected, asynchronously, during magnetic store writes.

Parameters:: s3_configuration (Union[IResolvable, S3ConfigurationProperty, Dict[str, Any], None]) – Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-magneticstorerejecteddatalocation.html
ExampleMetadata:: fixture=_generated

Example:

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

magnetic_store_rejected_data_location_property = timestream_mixins.CfnTablePropsMixin.MagneticStoreRejectedDataLocationProperty(
    s3_configuration=timestream_mixins.CfnTablePropsMixin.S3ConfigurationProperty(
        bucket_name="bucketName",
        encryption_option="encryptionOption",
        kms_key_id="kmsKeyId",
        object_key_prefix="objectKeyPrefix"
    )
)

Attributes

s3_configuration

Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-magneticstorerejecteddatalocation.html#cfn-timestream-table-magneticstorerejecteddatalocation-s3configuration

MagneticStoreWritePropertiesProperty

class CfnTablePropsMixin.MagneticStoreWritePropertiesProperty(*, enable_magnetic_store_writes=None, magnetic_store_rejected_data_location=None)

Bases: object

The set of properties on a table for configuring magnetic store writes.

Parameters:

enable_magnetic_store_writes (Union[bool, IResolvable, None]) – A flag to enable magnetic store writes.
magnetic_store_rejected_data_location (Union[IResolvable, MagneticStoreRejectedDataLocationProperty, Dict[str, Any], None]) – The location to write error reports for records rejected asynchronously during magnetic store writes.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

magnetic_store_write_properties_property = timestream_mixins.CfnTablePropsMixin.MagneticStoreWritePropertiesProperty(
    enable_magnetic_store_writes=False,
    magnetic_store_rejected_data_location=timestream_mixins.CfnTablePropsMixin.MagneticStoreRejectedDataLocationProperty(
        s3_configuration=timestream_mixins.CfnTablePropsMixin.S3ConfigurationProperty(
            bucket_name="bucketName",
            encryption_option="encryptionOption",
            kms_key_id="kmsKeyId",
            object_key_prefix="objectKeyPrefix"
        )
    )
)

Attributes

enable_magnetic_store_writes

A flag to enable magnetic store writes.

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

magnetic_store_rejected_data_location

The location to write error reports for records rejected asynchronously during magnetic store writes.

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

PartitionKeyProperty

class CfnTablePropsMixin.PartitionKeyProperty(*, enforcement_in_record=None, name=None, type=None)

Bases: object

An attribute used in partitioning data in a table.

A dimension key partitions data using the values of the dimension specified by the dimension-name as partition key, while a measure key partitions data using measure names (values of the ‘measure_name’ column).

Parameters:

enforcement_in_record (Optional[str]) – The level of enforcement for the specification of a dimension key in ingested records. Options are REQUIRED (dimension key must be specified) and OPTIONAL (dimension key does not have to be specified).
name (Optional[str]) – The name of the attribute used for a dimension key.
type (Optional[str]) – The type of the partition key. Options are DIMENSION (dimension key) and MEASURE (measure key).

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

partition_key_property = timestream_mixins.CfnTablePropsMixin.PartitionKeyProperty(
    enforcement_in_record="enforcementInRecord",
    name="name",
    type="type"
)

Attributes

enforcement_in_record

The level of enforcement for the specification of a dimension key in ingested records.

Options are REQUIRED (dimension key must be specified) and OPTIONAL (dimension key does not have to be specified).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-partitionkey.html#cfn-timestream-table-partitionkey-enforcementinrecord

name

The name of the attribute used for a dimension key.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-partitionkey.html#cfn-timestream-table-partitionkey-name

type

The type of the partition key.

Options are DIMENSION (dimension key) and MEASURE (measure key).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-partitionkey.html#cfn-timestream-table-partitionkey-type

RetentionPropertiesProperty

class CfnTablePropsMixin.RetentionPropertiesProperty(*, magnetic_store_retention_period_in_days=None, memory_store_retention_period_in_hours=None)

Bases: object

Retention properties contain the duration for which your time-series data must be stored in the magnetic store and the memory store.

Parameters:

magnetic_store_retention_period_in_days (Optional[str]) – The duration for which data must be stored in the magnetic store.
memory_store_retention_period_in_hours (Optional[str]) – The duration for which data must be stored in the memory store.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

retention_properties_property = timestream_mixins.CfnTablePropsMixin.RetentionPropertiesProperty(
    magnetic_store_retention_period_in_days="magneticStoreRetentionPeriodInDays",
    memory_store_retention_period_in_hours="memoryStoreRetentionPeriodInHours"
)

Attributes

magnetic_store_retention_period_in_days

The duration for which data must be stored in the magnetic store.

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

memory_store_retention_period_in_hours

The duration for which data must be stored in the memory store.

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

S3ConfigurationProperty

class CfnTablePropsMixin.S3ConfigurationProperty(*, bucket_name=None, encryption_option=None, kms_key_id=None, object_key_prefix=None)

Bases: object

The configuration that specifies an S3 location.

Parameters:

bucket_name (Optional[str]) – The bucket name of the customer S3 bucket.
encryption_option (Optional[str]) – The encryption option for the customer S3 location. Options are S3 server-side encryption with an S3 managed key or AWS managed key.
kms_key_id (Optional[str]) – The AWS key ID for the customer S3 location when encrypting with an AWS managed key.
object_key_prefix (Optional[str]) – The object key preview for the customer S3 location.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

s3_configuration_property = timestream_mixins.CfnTablePropsMixin.S3ConfigurationProperty(
    bucket_name="bucketName",
    encryption_option="encryptionOption",
    kms_key_id="kmsKeyId",
    object_key_prefix="objectKeyPrefix"
)

Attributes

bucket_name

The bucket name of the customer S3 bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-s3configuration.html#cfn-timestream-table-s3configuration-bucketname

encryption_option

The encryption option for the customer S3 location.

Options are S3 server-side encryption with an S3 managed key or AWS managed key.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-s3configuration.html#cfn-timestream-table-s3configuration-encryptionoption

kms_key_id

The AWS key ID for the customer S3 location when encrypting with an AWS managed key.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-s3configuration.html#cfn-timestream-table-s3configuration-kmskeyid

object_key_prefix

The object key preview for the customer S3 location.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-s3configuration.html#cfn-timestream-table-s3configuration-objectkeyprefix

SchemaProperty

class CfnTablePropsMixin.SchemaProperty(*, composite_partition_key=None)

Bases: object

A Schema specifies the expected data model of the table.

Parameters:: composite_partition_key (Union[IResolvable, Sequence[Union[IResolvable, PartitionKeyProperty, Dict[str, Any]]], None]) – A non-empty list of partition keys defining the attributes used to partition the table data. The order of the list determines the partition hierarchy. The name and type of each partition key as well as the partition key order cannot be changed after the table is created. However, the enforcement level of each partition key can be changed.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-schema.html
ExampleMetadata:: fixture=_generated

Example:

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

schema_property = timestream_mixins.CfnTablePropsMixin.SchemaProperty(
    composite_partition_key=[timestream_mixins.CfnTablePropsMixin.PartitionKeyProperty(
        enforcement_in_record="enforcementInRecord",
        name="name",
        type="type"
    )]
)

Attributes

composite_partition_key

A non-empty list of partition keys defining the attributes used to partition the table data.

The order of the list determines the partition hierarchy. The name and type of each partition key as well as the partition key order cannot be changed after the table is created. However, the enforcement level of each partition key can be changed.

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