Package software.amazon.awscdk.services.s3tables

Interface CfnTable.IcebergSchemaV2Property

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTable.IcebergSchemaV2Property.Jsii$Proxy

Enclosing class:

CfnTable

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

Contains details about the schema version 2 (V2) for an Iceberg table that supports Apache Iceberg Nested Types (struct, list, map).

Primitive types are also supported.

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.*;
 Object type;
 IcebergSchemaV2Property icebergSchemaV2Property = IcebergSchemaV2Property.builder()
         .schemaV2FieldList(List.of(SchemaV2FieldProperty.builder()
                 .id(123)
                 .name("name")
                 .required(false)
                 .type(type)
                 // the properties below are optional
                 .doc("doc")
                 .build()))
         .schemaV2FieldType("schemaV2FieldType")
         // the properties below are optional
         .identifierFieldIds(List.of(123))
         .schemaId(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTable.IcebergSchemaV2Property.Builder	builder()
default Object	getIdentifierFieldIds()	A list of field IDs that are used as the identifier fields for the table.
default Number	getSchemaId()	An optional unique identifier for the schema.
Object	getSchemaV2FieldList()	List of schema fields that support nested types.
String	getSchemaV2FieldType()	The type of the top-level schema, which is always 'struct'.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSchemaV2FieldList

@Stability(Stable)
@NotNull
Object getSchemaV2FieldList()

List of schema fields that support nested types.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTable.SchemaV2FieldProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergschemav2.html#cfn-s3tables-table-icebergschemav2-schemav2fieldlist

getSchemaV2FieldType

@Stability(Stable)
@NotNull
String getSchemaV2FieldType()

The type of the top-level schema, which is always 'struct'.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergschemav2.html#cfn-s3tables-table-icebergschemav2-schemav2fieldtype

getIdentifierFieldIds

@Stability(Stable)
@Nullable
default Object getIdentifierFieldIds()

A list of field IDs that are used as the identifier fields for the table.

Identifier fields uniquely identify a row in the table.

Returns union: either Listinvalid input: '<'Number> or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergschemav2.html#cfn-s3tables-table-icebergschemav2-identifierfieldids

getSchemaId

@Stability(Stable)
@Nullable
default Number getSchemaId()

An optional unique identifier for the schema.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergschemav2.html#cfn-s3tables-table-icebergschemav2-schemaid

builder

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

Returns:

a CfnTable.IcebergSchemaV2Property.Builder of CfnTable.IcebergSchemaV2Property