aws-cdk-lib.aws_amplifyuibuilder.CfnForm.FieldInputConfigProperty

interface FieldInputConfigProperty

LanguageType name
.NETAmazon.CDK.AWS.AmplifyUIBuilder.CfnForm.FieldInputConfigProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsamplifyuibuilder#CfnForm_FieldInputConfigProperty
Javasoftware.amazon.awscdk.services.amplifyuibuilder.CfnForm.FieldInputConfigProperty
Pythonaws_cdk.aws_amplifyuibuilder.CfnForm.FieldInputConfigProperty
TypeScript aws-cdk-lib » aws_amplifyuibuilder » CfnForm » FieldInputConfigProperty

The FieldInputConfig property specifies the configuration for the default input values to display for a field.

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';
const fieldInputConfigProperty: amplifyuibuilder.CfnForm.FieldInputConfigProperty = {
  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: {
        value: 'value',
      },

      // the properties below are optional
      displayValue: {
        value: 'value',
      },
    }],
  },
};

Properties

NameTypeDescription
typestringThe input type for the field.
defaultChecked?boolean | IResolvableSpecifies whether a field has a default value.
defaultCountryCode?stringThe default country code for a phone number.
defaultValue?stringThe default value for the field.
descriptiveText?stringThe text to display to describe the field.
fileUploaderConfig?IResolvable | FileUploaderFieldConfigPropertyThe configuration for the file uploader field.
isArray?boolean | IResolvableSpecifies whether to render the field as an array.
maxValue?numberThe maximum value to display for the field.
minValue?numberThe minimum value to display for the field.
name?stringThe name of the field.
placeholder?stringThe text to display as a placeholder for the field.
readOnly?boolean | IResolvableSpecifies a read only field.
required?boolean | IResolvableSpecifies a field that requires input.
step?numberThe stepping increment for a numeric value in a field.
value?stringThe value for the field.
valueMappings?IResolvable | ValueMappingsPropertyThe information to use to customize the input fields with data at runtime.

type

Type: string

The input type for the field.


defaultChecked?

Type: boolean | IResolvable (optional)

Specifies whether a field has a default value.


defaultCountryCode?

Type: string (optional)

The default country code for a phone number.


defaultValue?

Type: string (optional)

The default value for the field.


descriptiveText?

Type: string (optional)

The text to display to describe the field.


fileUploaderConfig?

Type: IResolvable | FileUploaderFieldConfigProperty (optional)

The configuration for the file uploader field.


isArray?

Type: boolean | IResolvable (optional)

Specifies whether to render the field as an array.

This property is ignored if the dataSourceType for the form is a Data Store.


maxValue?

Type: number (optional)

The maximum value to display for the field.


minValue?

Type: number (optional)

The minimum value to display for the field.


name?

Type: string (optional)

The name of the field.


placeholder?

Type: string (optional)

The text to display as a placeholder for the field.


readOnly?

Type: boolean | IResolvable (optional)

Specifies a read only field.


required?

Type: boolean | IResolvable (optional)

Specifies a field that requires input.


step?

Type: number (optional)

The stepping increment for a numeric value in a field.


value?

Type: string (optional)

The value for the field.


valueMappings?

Type: IResolvable | ValueMappingsProperty (optional)

The information to use to customize the input fields with data at runtime.