Package software.amazon.awscdk.cfnpropertymixins.services.s3tables

Interface CfnTablePropsMixin.SchemaFieldProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTablePropsMixin.SchemaFieldProperty.Jsii$Proxy

Enclosing class:

CfnTablePropsMixin

@Stability(Stable)
public static interface CfnTablePropsMixin.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.cfnpropertymixins.services.s3tables.*;
 SchemaFieldProperty schemaFieldProperty = SchemaFieldProperty.builder()
         .id(123)
         .name("name")
         .required(false)
         .type("type")
         .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	CfnTablePropsMixin.SchemaFieldProperty.Builder	A builder for CfnTablePropsMixin.SchemaFieldProperty
static final class	CfnTablePropsMixin.SchemaFieldProperty.Jsii$Proxy	An implementation for CfnTablePropsMixin.SchemaFieldProperty

Method Summary

Modifier and Type	Method	Description
static CfnTablePropsMixin.SchemaFieldProperty.Builder	builder()
default Number	getId()	The unique identifier for the field.
default 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.
default String	getType()	The field type.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getId

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

The unique identifier for the field.

See Also:

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

getName

@Stability(Stable)
@Nullable
default 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

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.

Returns union: either Boolean or IResolvable

See Also:

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

getType

@Stability(Stable)
@Nullable
default 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

builder

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

Returns:

a CfnTablePropsMixin.SchemaFieldProperty.Builder of CfnTablePropsMixin.SchemaFieldProperty