CfnTable

class aws_cdk.aws_timestream.CfnTable(scope, id, *, database_name, magnetic_store_write_properties=None, retention_properties=None, schema=None, table_name=None, tags=None)

Bases: CfnResource

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
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 import aws_timestream as timestream

# magnetic_store_write_properties: Any
# retention_properties: Any

cfn_table = timestream.CfnTable(self, "MyCfnTable",
    database_name="databaseName",

    # the properties below are optional
    magnetic_store_write_properties=magnetic_store_write_properties,
    retention_properties=retention_properties,
    schema=timestream.CfnTable.SchemaProperty(
        composite_partition_key=[timestream.CfnTable.PartitionKeyProperty(
            type="type",

            # the properties below are optional
            enforcement_in_record="enforcementInRecord",
            name="name"
        )]
    ),
    table_name="tableName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
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” KmsKeyId: “1234abcd-12ab-34cd-56ef-1234567890ab” ObjectKeyPrefix: “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”
schema (Union[IResolvable, SchemaProperty, Dict[str, Any], None]) – The schema of the table.
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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Timestream::Table'

attr_arn

The arn of the table.

CloudformationAttribute:: Arn

attr_name

The name of the table.

CloudformationAttribute:: Name

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

database_name: The name of the Timestream database that contains this table.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

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

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

retention_properties

The retention duration for the memory store and magnetic store.

This object has the following attributes:.

schema: The schema of the table.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

table_name: The name of the Timestream table.

tags: Tag Manager which manages the tags for this resource.

tags_raw: The tags to add to the table.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

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

MagneticStoreRejectedDataLocationProperty

class CfnTable.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 import aws_timestream as timestream

magnetic_store_rejected_data_location_property = timestream.CfnTable.MagneticStoreRejectedDataLocationProperty(
    s3_configuration=timestream.CfnTable.S3ConfigurationProperty(
        bucket_name="bucketName",
        encryption_option="encryptionOption",

        # the properties below are optional
        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 CfnTable.MagneticStoreWritePropertiesProperty(*, enable_magnetic_store_writes, 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]) – 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 import aws_timestream as timestream

magnetic_store_write_properties_property = timestream.CfnTable.MagneticStoreWritePropertiesProperty(
    enable_magnetic_store_writes=False,

    # the properties below are optional
    magnetic_store_rejected_data_location=timestream.CfnTable.MagneticStoreRejectedDataLocationProperty(
        s3_configuration=timestream.CfnTable.S3ConfigurationProperty(
            bucket_name="bucketName",
            encryption_option="encryptionOption",

            # the properties below are optional
            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 CfnTable.PartitionKeyProperty(*, type, enforcement_in_record=None, name=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:

type (str) – The type of the partition key. Options are DIMENSION (dimension key) and MEASURE (measure key).
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.

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 import aws_timestream as timestream

partition_key_property = timestream.CfnTable.PartitionKeyProperty(
    type="type",

    # the properties below are optional
    enforcement_in_record="enforcementInRecord",
    name="name"
)

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 CfnTable.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 import aws_timestream as timestream

retention_properties_property = timestream.CfnTable.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 CfnTable.S3ConfigurationProperty(*, bucket_name, encryption_option, kms_key_id=None, object_key_prefix=None)

Bases: object

The configuration that specifies an S3 location.

Parameters:

bucket_name (str) – The bucket name of the customer S3 bucket.
encryption_option (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 KMS 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 import aws_timestream as timestream

s3_configuration_property = timestream.CfnTable.S3ConfigurationProperty(
    bucket_name="bucketName",
    encryption_option="encryptionOption",

    # the properties below are optional
    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 KMS 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 CfnTable.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 import aws_timestream as timestream

schema_property = timestream.CfnTable.SchemaProperty(
    composite_partition_key=[timestream.CfnTable.PartitionKeyProperty(
        type="type",

        # the properties below are optional
        enforcement_in_record="enforcementInRecord",
        name="name"
    )]
)

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