Package software.amazon.awscdk.services.s3tables

Interface CfnTable.SchemaFieldProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTable.SchemaFieldProperty.Jsii$Proxy

Enclosing class:

CfnTable

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

Contains details about a schema field.

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.*;
 SchemaFieldProperty schemaFieldProperty = SchemaFieldProperty.builder()
         .name("name")
         .type("type")
         // the properties below are optional
         .required(false)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTable.SchemaFieldProperty.Builder	builder()
String	getName()	The name of the field.
default Object	getRequired()	A Boolean value that specifies whether values are required for each row in this field.
String	getType()	The field type.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the field.

See Also:

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

getType

@Stability(Stable)
@NotNull
String getType()

The field type.

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

See Also:

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

getRequired

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

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.

See Also:

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

builder

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

Returns:

a CfnTable.SchemaFieldProperty.Builder of CfnTable.SchemaFieldProperty