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

Interface CfnTablePropsMixin.SchemaV2FieldProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTablePropsMixin.SchemaV2FieldProperty.Jsii$Proxy

Enclosing class:

CfnTablePropsMixin

@Stability(Stable)
public static interface CfnTablePropsMixin.SchemaV2FieldProperty
extends software.amazon.jsii.JsiiSerializable

Contains details about a schema field for an Iceberg table that supports nested types (struct, list, map).

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.*;
 Object type;
 SchemaV2FieldProperty schemaV2FieldProperty = SchemaV2FieldProperty.builder()
         .doc("doc")
         .id(123)
         .name("name")
         .required(false)
         .type(type)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTablePropsMixin.SchemaV2FieldProperty.Builder	builder()
default String	getDoc()	Optional documentation for the field.
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 Object	getType()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDoc

@Stability(Stable)
@Nullable
default String getDoc()

Optional documentation for the field.

See Also:

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

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-schemav2field.html#cfn-s3tables-table-schemav2field-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-schemav2field.html#cfn-s3tables-table-schemav2field-name

getRequired

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

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

Returns union: either Boolean or IResolvable

See Also:

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

getType

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

See Also:

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

builder

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

Returns:

a CfnTablePropsMixin.SchemaV2FieldProperty.Builder of CfnTablePropsMixin.SchemaV2FieldProperty