@aws-cdk/aws-s3tables-alpha.SchemaFieldProperty

Experimental

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

SchemaFieldProperty Struct

Contains details about a schema field.

Stability

Experimental

Source

lib/table.ts

Example

// 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';
const schemaFieldProperty: s3tables_alpha.SchemaFieldProperty = {
  name: 'name',
  type: 'type',

  // the properties below are optional
  id: 123,
  required: false,
};

Properties

id?optionalnumberid?optionalint | floatid?optionalNumberId?optionaldoubleId?optional*float64#

The unique identifier for the field.

Default: Auto-assigned by S3 Tables

namestringnamestrnameStringNamestringName*stringrequired#

The name of the field.

required?optionalbooleanrequired?optionalboolrequired?optionalBooleanRequired?optionalboolRequired?optional*bool= false#

A Boolean value that specifies whether values are required for each row in this field.

By default, this is false and null values are allowed in the field. If this is true, the field does not allow null values.

typestringtypestrtypeStringTypestringType*stringrequired#

The field type.

S3 Tables supports all Apache Iceberg primitive types. For more information, see the Apache Iceberg documentation.