Package software.amazon.awscdk.services.timestream

Interface CfnTable.PartitionKeyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTable.PartitionKeyProperty.Jsii$Proxy

Enclosing class:

CfnTable

@Stability(Stable)
public static interface CfnTable.PartitionKeyProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.timestream.*;
 PartitionKeyProperty partitionKeyProperty = PartitionKeyProperty.builder()
         .type("type")
         // the properties below are optional
         .enforcementInRecord("enforcementInRecord")
         .name("name")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTable.PartitionKeyProperty.Builder	A builder for CfnTable.PartitionKeyProperty
static final class	CfnTable.PartitionKeyProperty.Jsii$Proxy	An implementation for CfnTable.PartitionKeyProperty

Method Summary

Modifier and Type	Method	Description
static CfnTable.PartitionKeyProperty.Builder	builder()
default String	getEnforcementInRecord()	The level of enforcement for the specification of a dimension key in ingested records.
default String	getName()	The name of the attribute used for a dimension key.
String	getType()	The type of the partition key.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getType

@Stability(Stable)
@NotNull
String getType()

The type of the partition key.

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

See Also:

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

getEnforcementInRecord

@Stability(Stable)
@Nullable
default String getEnforcementInRecord()

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 Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the attribute used for a dimension key.

See Also:

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

builder

@Stability(Stable)
static CfnTable.PartitionKeyProperty.Builder builder()

Returns:

a CfnTable.PartitionKeyProperty.Builder of CfnTable.PartitionKeyProperty