@aws-cdk/aws-s3tables-alpha 2.244.0-alpha.0 → 2.246.0-alpha.0

package/lib/table.d.ts

@@ -1,6 +1,6 @@
 import * as iam from 'aws-cdk-lib/aws-iam';
 import { CfnTablePolicy } from 'aws-cdk-lib/aws-s3tables';
-import type { IResource, RemovalPolicy } from 'aws-cdk-lib/core';
+import type { IResource, ITaggableV2, RemovalPolicy, TagManager } from 'aws-cdk-lib/core';
 import { Resource } from 'aws-cdk-lib/core';
 import type { Construct } from 'constructs';
 import type { INamespace } from './namespace';
@@ -198,17 +198,213 @@ export declare enum Status {
      */
     DISABLED = "disabled"
 }
+/**
+ * Iceberg transform values for partition and sort fields.
+ */
+export declare class IcebergTransform {
+    /**
+     * Use the column value as the transform value without transformation.
+     */
+    static readonly IDENTITY: IcebergTransform;
+    /**
+     * Transform a timestamp/date field to year.
+     */
+    static readonly YEAR: IcebergTransform;
+    /**
+     * Transform a timestamp/date field to month.
+     */
+    static readonly MONTH: IcebergTransform;
+    /**
+     * Transform a timestamp/date field to day.
+     */
+    static readonly DAY: IcebergTransform;
+    /**
+     * Transform a timestamp field to hour.
+     */
+    static readonly HOUR: IcebergTransform;
+    /**
+     * Transform values into a fixed number of buckets.
+     *
+     * @param n The number of buckets (must be a positive integer)
+     */
+    static bucket(n: number): IcebergTransform;
+    /**
+     * Truncate values to a fixed width.
+     *
+     * @param width The truncation width (must be a positive integer)
+     */
+    static truncate(width: number): IcebergTransform;
+    /**
+     * Create a custom transform from a string value.
+     *
+     * @param value The transform string value
+     */
+    static of(value: string): IcebergTransform;
+    /**
+     * The string value of the transform.
+     */
+    readonly value: string;
+    private constructor();
+    /**
+     * Returns the string representation of the transform.
+     */
+    toString(): string;
+}
+/**
+ * Sort direction values for Iceberg sort fields.
+ */
+export declare enum SortDirection {
+    /**
+     * Sort values in ascending order.
+     */
+    ASC = "asc",
+    /**
+     * Sort values in descending order.
+     */
+    DESC = "desc"
+}
+/**
+ * Null ordering values for Iceberg sort fields.
+ */
+export declare enum NullOrder {
+    /**
+     * Place null values before non-null values.
+     */
+    NULLS_FIRST = "nulls-first",
+    /**
+     * Place null values after non-null values.
+     */
+    NULLS_LAST = "nulls-last"
+}
+/**
+ * Partition field definition for Iceberg table.
+ *
+ * Defines a single partition column. Multiple partition fields can be combined
+ * in an IcebergPartitionSpec to create multi-level partitioning.
+ */
+export interface IcebergPartitionField {
+    /**
+     * The source field ID from the schema.
+     */
+    readonly sourceId: number;
+    /**
+     * The partition transform function.
+     *
+     * Use `IcebergTransform` static properties for common transforms (e.g., `IcebergTransform.IDENTITY`)
+     * or methods for parameterized transforms (e.g., `IcebergTransform.bucket(16)`).
+     */
+    readonly transform: IcebergTransform;
+    /**
+     * The name of the partition field.
+     */
+    readonly name: string;
+    /**
+     * The unique identifier for the partition field.
+     *
+     * @default - Auto-assigned starting from 1000
+     */
+    readonly fieldId?: number;
+}
+/**
+ * Partition specification for Iceberg table.
+ *
+ * Contains the complete partitioning configuration for a table, including all partition fields.
+ * Use this to define multi-level partitioning (e.g., partition by date, then by region).
+ */
+export interface IcebergPartitionSpec {
+    /**
+     * The list of partition fields.
+     */
+    readonly fields: IcebergPartitionField[];
+    /**
+     * The unique identifier for the partition specification.
+     *
+     * @default 0
+     */
+    readonly specId?: number;
+}
+/**
+ * Sort field definition for Iceberg table.
+ */
+export interface IcebergSortField {
+    /**
+     * The source field ID from the schema.
+     */
+    readonly sourceId: number;
+    /**
+     * The sort transform function.
+     *
+     * Use `IcebergTransform` static properties for common transforms (e.g., `IcebergTransform.IDENTITY`)
+     * or methods for parameterized transforms (e.g., `IcebergTransform.bucket(16)`).
+     */
+    readonly transform: IcebergTransform;
+    /**
+     * The sort direction.
+     */
+    readonly direction: SortDirection;
+    /**
+     * The null ordering.
+     */
+    readonly nullOrder: NullOrder;
+}
+/**
+ * Sort order specification for Iceberg table.
+ */
+export interface IcebergSortOrder {
+    /**
+     * The list of sort fields.
+     */
+    readonly fields: IcebergSortField[];
+    /**
+     * The unique identifier for the sort order.
+     *
+     * @default 1
+     */
+    readonly orderId?: number;
+}
+/**
+ * A single table property key-value pair for Iceberg table configuration.
+ */
+export interface TablePropertyEntry {
+    /**
+     * The property key.
+     */
+    readonly key: string;
+    /**
+     * The property value.
+     */
+    readonly value: string;
+}
 /**
  * Contains details about the metadata for an Iceberg table.
- * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergmetadata.html
+ * @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergmetadata.html
  */
 export interface IcebergMetadataProperty {
     /**
      * Contains details about the schema for an Iceberg table.
      *
-     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergmetadata.html#cfn-s3tables-table-icebergmetadata-icebergschema
+     * @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergmetadata.html#cfn-s3tables-table-icebergmetadata-icebergschema
      */
     readonly icebergSchema: IcebergSchemaProperty;
+    /**
+     * The partition specification for the Iceberg table.
+     *
+     * @default - No partition specification
+     */
+    readonly icebergPartitionSpec?: IcebergPartitionSpec;
+    /**
+     * The sort order for the Iceberg table.
+     *
+     * @default - No sort order
+     */
+    readonly icebergSortOrder?: IcebergSortOrder;
+    /**
+     * Custom properties for the Iceberg table.
+     * Each entry represents a key-value pair for Iceberg table configuration.
+     *
+     * @default - No custom properties
+     */
+    readonly tableProperties?: TablePropertyEntry[];
 }
 /**
  * Contains details about the schema for an Iceberg table.
@@ -223,6 +419,12 @@ export interface IcebergSchemaProperty {
  * Contains details about a schema field.
  */
 export interface SchemaFieldProperty {
+    /**
+     * The unique identifier for the field.
+     *
+     * @default - Auto-assigned by S3 Tables
+     */
+    readonly id?: number;
     /**
      * The name of the field.
      */
@@ -288,7 +490,7 @@ export interface TableAttributes {
 /**
  * An S3 Table with helpers.
  */
-export declare class Table extends TableBase {
+export declare class Table extends TableBase implements ITaggableV2 {
     /** Uniquely identifies this class. */
     static readonly PROPERTY_INJECTION_ID: string;
     /**
@@ -314,6 +516,10 @@ export declare class Table extends TableBase {
      * @internal
      */
     private readonly _resource;
+    /**
+     * The tag manager for this resource.
+     */
+    readonly cdkTagManager: TagManager;
     /**
      * The name of this table
      */
@@ -328,5 +534,25 @@ export declare class Table extends TableBase {
     readonly tablePolicy?: CfnTablePolicy;
     protected autoCreatePolicy: boolean;
     constructor(scope: Construct, id: string, props: TableProps);
+    /**
+     * Builds the CloudFormation Iceberg metadata property from the CDK metadata model.
+     */
+    private buildIcebergMetadata;
+    /**
+     * Builds the CloudFormation Iceberg schema property.
+     */
+    private buildIcebergSchema;
+    /**
+     * Builds the CloudFormation Iceberg partition specification property.
+     */
+    private buildIcebergPartitionSpec;
+    /**
+     * Builds the CloudFormation Iceberg sort order property.
+     */
+    private buildIcebergSortOrder;
+    /**
+     * Builds the CloudFormation table properties map from key-value entries.
+     */
+    private buildTableProperties;
 }
 export {};