interface PartitionKeyProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Timestream.CfnTable.PartitionKeyProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awstimestream#CfnTable_PartitionKeyProperty`
Java	`software.amazon.awscdk.services.timestream.CfnTable.PartitionKeyProperty`
Python	`aws_cdk.aws_timestream.CfnTable.PartitionKeyProperty`
TypeScript	`aws-cdk-lib` » `aws_timestream` » `CfnTable` » `PartitionKeyProperty`

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).

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_timestream as timestream } from 'aws-cdk-lib';
const partitionKeyProperty: timestream.CfnTable.PartitionKeyProperty = {
  type: 'type',

  // the properties below are optional
  enforcementInRecord: 'enforcementInRecord',
  name: 'name',
};

Properties

Name	Type	Description
type	`string`	The type of the partition key.
enforcementInRecord?	`string`	The level of enforcement for the specification of a dimension key in ingested records.
name?	`string`	The name of the attribute used for a dimension key.

type

Type: string

The type of the partition key.

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

enforcementInRecord?

Type: string (optional)

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?

Type: string (optional)

The name of the attribute used for a dimension key.