interface FieldConfigProperty

Language	Type name
.NET	`Amazon.CDK.AWS.AmplifyUIBuilder.CfnForm.FieldConfigProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsamplifyuibuilder#CfnForm_FieldConfigProperty`
Java	`software.amazon.awscdk.services.amplifyuibuilder.CfnForm.FieldConfigProperty`
Python	`aws_cdk.aws_amplifyuibuilder.CfnForm.FieldConfigProperty`
TypeScript	`aws-cdk-lib` » `aws_amplifyuibuilder` » `CfnForm` » `FieldConfigProperty`

The FieldConfig property specifies the configuration information for a field in a table.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_amplifyuibuilder as amplifyuibuilder } from 'aws-cdk-lib';

declare const formInputValuePropertyProperty_: amplifyuibuilder.CfnForm.FormInputValuePropertyProperty;
const fieldConfigProperty: amplifyuibuilder.CfnForm.FieldConfigProperty = {
  excluded: false,
  inputType: {
    type: 'type',

    // the properties below are optional
    defaultChecked: false,
    defaultCountryCode: 'defaultCountryCode',
    defaultValue: 'defaultValue',
    descriptiveText: 'descriptiveText',
    fileUploaderConfig: {
      acceptedFileTypes: ['acceptedFileTypes'],
      accessLevel: 'accessLevel',

      // the properties below are optional
      isResumable: false,
      maxFileCount: 123,
      maxSize: 123,
      showThumbnails: false,
    },
    isArray: false,
    maxValue: 123,
    minValue: 123,
    name: 'name',
    placeholder: 'placeholder',
    readOnly: false,
    required: false,
    step: 123,
    value: 'value',
    valueMappings: {
      values: [{
        value: {
          bindingProperties: {
            property: 'property',

            // the properties below are optional
            field: 'field',
          },
          concat: [formInputValuePropertyProperty_],
          value: 'value',
        },

        // the properties below are optional
        displayValue: {
          bindingProperties: {
            property: 'property',

            // the properties below are optional
            field: 'field',
          },
          concat: [formInputValuePropertyProperty_],
          value: 'value',
        },
      }],

      // the properties below are optional
      bindingProperties: {
        bindingPropertiesKey: {
          bindingProperties: {
            model: 'model',
          },
          type: 'type',
        },
      },
    },
  },
  label: 'label',
  position: {
    below: 'below',
    fixed: 'fixed',
    rightOf: 'rightOf',
  },
  validations: [{
    type: 'type',

    // the properties below are optional
    numValues: [123],
    strValues: ['strValues'],
    validationMessage: 'validationMessage',
  }],
};

Properties

Name	Type	Description
excluded?	`boolean \|` `IResolvable`	Specifies whether to hide a field.
inputType?	`IResolvable` `\|` `FieldInputConfigProperty`	Describes the configuration for the default input value to display for a field.
label?	`string`	The label for the field.
position?	`IResolvable` `\|` `FieldPositionProperty`	Specifies the field position.
validations?	`IResolvable` `\|` `IResolvable` `\|` `FieldValidationConfigurationProperty[]`	The validations to perform on the value in the field.

excluded?

Type: boolean | IResolvable (optional)

Specifies whether to hide a field.

inputType?

Type: IResolvable | FieldInputConfigProperty (optional)

Describes the configuration for the default input value to display for a field.

label?

Type: string (optional)

The label for the field.

position?

Type: IResolvable | FieldPositionProperty (optional)

Specifies the field position.

validations?

Type: IResolvable | IResolvable | FieldValidationConfigurationProperty[] (optional)

The validations to perform on the value in the field.