Package software.amazon.awscdk.services.s3tables.alpha

Interface IcebergPartitionField

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IcebergPartitionField.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-02T21:55:36.205Z")
@Stability(Experimental)
public interface IcebergPartitionField
extends software.amazon.jsii.JsiiSerializable

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

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.s3tables.alpha.*;
 IcebergTransform icebergTransform;
 IcebergPartitionField icebergPartitionField = IcebergPartitionField.builder()
         .name("name")
         .sourceId(123)
         .transform(icebergTransform)
         // the properties below are optional
         .fieldId(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static IcebergPartitionField.Builder	builder()
default Number	getFieldId()	(experimental) The unique identifier for the partition field.
String	getName()	(experimental) The name of the partition field.
Number	getSourceId()	(experimental) The source field ID from the schema.
IcebergTransform	getTransform()	(experimental) The partition transform function.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Experimental)
@NotNull
String getName()

(experimental) The name of the partition field.

getSourceId

@Stability(Experimental)
@NotNull
Number getSourceId()

(experimental) The source field ID from the schema.

getTransform

@Stability(Experimental)
@NotNull
IcebergTransform getTransform()

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

getFieldId

@Stability(Experimental)
@Nullable
default Number getFieldId()

(experimental) The unique identifier for the partition field.

Default: - Auto-assigned starting from 1000

builder

@Stability(Experimental)
static IcebergPartitionField.Builder builder()

Returns:

a IcebergPartitionField.Builder of IcebergPartitionField