Skip to content
v2.275.0

FieldDefinitionProperty Struct ​

Defines a field in an entity schema.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_glue as glue } from 'aws-cdk-lib';
const fieldDefinitionProperty: glue.CfnConnectionType.FieldDefinitionProperty = {
  fieldDataType: 'fieldDataType',
  name: 'name',

  // the properties below are optional
  filterOverrides: {
    betweenConfiguration: {
      highBoundKey: 'highBoundKey',
      lowBoundKey: 'lowBoundKey',
      template: 'template',
    },
    dateTimeFormat: 'dateTimeFormat',
    fieldName: 'fieldName',
    operatorMappings: {
      operatorMappingsKey: 'operatorMappings',
    },
  },
  isNullable: false,
  isOrderable: false,
  isPartitionable: false,
  isQueryable: false,
  responseDateFormat: 'responseDateFormat',
};

Properties ​

fieldDataTypestringfield_data_typestrfieldDataTypeStringFieldDataTypestringFieldDataType*stringrequired#
The data type of the field.
filterOverridesoptionalIResolvable | CfnConnectionType.FilterOverridesPropertyfilter_overridesoptionaltyping.Union[IResolvable, FilterOverridesProperty]filterOverridesoptionalIResolvableFilterOverridesoptionalIResolvableFilterOverridesoptionalinterface{}#
Configuration that defines per-field overrides for filter behavior, allowing individual fields to customize how filter operations are applied.
isNullableoptionalboolean | IResolvableis_nullableoptionaltyping.Union[bool, IResolvable]isNullableoptionalBooleanIsNullableoptionalboolIsNullableoptionalinterface{}#
Indicates whether this field can contain null values.
isOrderableoptionalboolean | IResolvableis_orderableoptionaltyping.Union[bool, IResolvable]isOrderableoptionalBooleanIsOrderableoptionalboolIsOrderableoptionalinterface{}#
Indicates whether this field can be used for ordering results.
isPartitionableoptionalboolean | IResolvableis_partitionableoptionaltyping.Union[bool, IResolvable]isPartitionableoptionalBooleanIsPartitionableoptionalboolIsPartitionableoptionalinterface{}#
Indicates whether this field can be used for partitioning queries to the data source.
isQueryableoptionalboolean | IResolvableis_queryableoptionaltyping.Union[bool, IResolvable]isQueryableoptionalBooleanIsQueryableoptionalboolIsQueryableoptionalinterface{}#
Indicates whether this field can be used in filter predicates when querying data.
namestringnamestrnameStringNamestringName*stringrequired#
The name of the field.
responseDateFormatoptionalstringresponse_date_formatoptionalstrresponseDateFormatoptionalStringResponseDateFormatoptionalstringResponseDateFormatoptional*string#
The format pattern for parsing date values from API responses.

Accepts Java DateTimeFormatter patterns, EPOCH_SECONDS, or EPOCH_MILLIS.