Skip to content
v2.277.0

Experimental

@aws-cdk/aws-s3tables-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

IcebergPartitionField Struct ​

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 ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as s3tables_alpha from '@aws-cdk/aws-s3tables-alpha';

declare const icebergTransform: s3tables_alpha.IcebergTransform;
const icebergPartitionField: s3tables_alpha.IcebergPartitionField = {
  name: 'name',
  sourceId: 123,
  transform: icebergTransform,

  // the properties below are optional
  fieldId: 123,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_s3tables_alpha as s3tables_alpha

# iceberg_transform: s3tables_alpha.IcebergTransform

iceberg_partition_field = s3tables_alpha.IcebergPartitionField(
    name="name",
    source_id=123,
    transform=iceberg_transform,

    # the properties below are optional
    field_id=123
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.AWS.S3Tables.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.S3Tables.Alpha;

IcebergTransform icebergTransform;

var icebergPartitionField = new IcebergPartitionField {
    Name = "name",
    SourceId = 123,
    Transform = icebergTransform,

    // the properties below are optional
    FieldId = 123
};
go
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import s3tables_alpha "github.com/aws-samples/dummy/awscdkawss3tablesalpha"

var icebergTransform IcebergTransform

icebergPartitionField := &IcebergPartitionField{
	Name: jsii.String("name"),
	SourceId: jsii.Number(123),
	Transform: icebergTransform,

	// the properties below are optional
	FieldId: jsii.Number(123),
}

Properties ​

fieldIdoptionalnumberfield_idoptionalint | floatfieldIdoptionalNumberFieldIdoptionaldoubleFieldIdoptional*float64 #
The unique identifier for the partition field.

Default: Auto-assigned starting from 1000

namestringnamestrnameStringNamestringName*string required #
The name of the partition field.
sourceIdnumbersource_idint | floatsourceIdNumberSourceIddoubleSourceId*float64 required #
The source field ID from the schema.
transformIcebergTransformtransformIcebergTransformtransformIcebergTransformTransformIcebergTransformTransformIcebergTransform required #
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)).