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

Interface CompactionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CompactionProperty.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-08-06T18:14:48.671Z")
@Stability(Experimental)
public interface CompactionProperty
extends software.amazon.jsii.JsiiSerializable

(experimental) Settings governing the Compaction maintenance action.

Default: - No compaction settings

Example:

 // Build a table
 Table sampleTable = Table.Builder.create(scope, "ExampleTable")
         .tableName("example_table")
         .namespace(namespace)
         .openTableFormat(OpenTableFormat.ICEBERG)
         .withoutMetadata(true)
         .build();
 // Build a table with an Iceberg Schema
 Table sampleTableWithSchema = Table.Builder.create(scope, "ExampleSchemaTable")
         .tableName("example_table_with_schema")
         .namespace(namespace)
         .openTableFormat(OpenTableFormat.ICEBERG)
         .icebergMetadata(IcebergMetadataProperty.builder()
                 .icebergSchema(IcebergSchemaProperty.builder()
                         .schemaFieldList(List.of(SchemaFieldProperty.builder()
                                 .name("id")
                                 .type("int")
                                 .required(true)
                                 .build(), SchemaFieldProperty.builder()
                                 .name("name")
                                 .type("string")
                                 .build()))
                         .build())
                 .build())
         .compaction(CompactionProperty.builder()
                 .status(Status.ENABLED)
                 .targetFileSizeMb(128)
                 .build())
         .snapshotManagement(SnapshotManagementProperty.builder()
                 .status(Status.ENABLED)
                 .maxSnapshotAgeHours(48)
                 .minSnapshotsToKeep(5)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CompactionProperty.Builder	builder()
Status	getStatus()	(experimental) Status of the compaction maintenance action.
Number	getTargetFileSizeMb()	(experimental) Target file size in megabytes for compaction.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getStatus

@Stability(Experimental)
@NotNull
Status getStatus()

(experimental) Status of the compaction maintenance action.

getTargetFileSizeMb

@Stability(Experimental)
@NotNull
Number getTargetFileSizeMb()

(experimental) Target file size in megabytes for compaction.

builder

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

Returns:

a CompactionProperty.Builder of CompactionProperty