aws-cdk-lib.aws_amplifyuibuilder.CfnFormProps

interface CfnFormProps

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

Properties for defining a CfnForm.

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 cfnFormProps: amplifyuibuilder.CfnFormProps = {
  dataType: {
    dataSourceType: 'dataSourceType',
    dataTypeName: 'dataTypeName',
  },
  fields: {
    fieldsKey: {
      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: {
              value: 'value',
            },

            // the properties below are optional
            displayValue: {
              value: 'value',
            },
          }],
        },
      },
      label: 'label',
      position: {
        below: 'below',
        fixed: 'fixed',
        rightOf: 'rightOf',
      },
      validations: [{
        type: 'type',

        // the properties below are optional
        numValues: [123],
        strValues: ['strValues'],
        validationMessage: 'validationMessage',
      }],
    },
  },
  formActionType: 'formActionType',
  name: 'name',
  schemaVersion: 'schemaVersion',
  sectionalElements: {
    sectionalElementsKey: {
      type: 'type',

      // the properties below are optional
      excluded: false,
      level: 123,
      orientation: 'orientation',
      position: {
        below: 'below',
        fixed: 'fixed',
        rightOf: 'rightOf',
      },
      text: 'text',
    },
  },
  style: {
    horizontalGap: {
      tokenReference: 'tokenReference',
      value: 'value',
    },
    outerPadding: {
      tokenReference: 'tokenReference',
      value: 'value',
    },
    verticalGap: {
      tokenReference: 'tokenReference',
      value: 'value',
    },
  },

  // the properties below are optional
  appId: 'appId',
  cta: {
    cancel: {
      children: 'children',
      excluded: false,
      position: {
        below: 'below',
        fixed: 'fixed',
        rightOf: 'rightOf',
      },
    },
    clear: {
      children: 'children',
      excluded: false,
      position: {
        below: 'below',
        fixed: 'fixed',
        rightOf: 'rightOf',
      },
    },
    position: 'position',
    submit: {
      children: 'children',
      excluded: false,
      position: {
        below: 'below',
        fixed: 'fixed',
        rightOf: 'rightOf',
      },
    },
  },
  environmentName: 'environmentName',
  labelDecorator: 'labelDecorator',
  tags: {
    tagsKey: 'tags',
  },
};

Properties

NameTypeDescription
dataTypeIResolvable | FormDataTypeConfigPropertyThe type of data source to use to create the form.
fieldsIResolvable | { [string]: IResolvable | FieldConfigProperty }The configuration information for the form's fields.
formActionTypestringSpecifies whether to perform a create or update action on the form.
namestringThe name of the form.
schemaVersionstringThe schema version of the form.
sectionalElementsIResolvable | { [string]: IResolvable | SectionalElementProperty }The configuration information for the visual helper elements for the form.
styleIResolvable | FormStylePropertyThe configuration for the form's style.
appId?stringThe unique ID of the Amplify app associated with the form.
cta?IResolvable | FormCTAPropertyThe FormCTA object that stores the call to action configuration for the form.
environmentName?stringThe name of the backend environment that is a part of the Amplify app.
labelDecorator?stringSpecifies an icon or decoration to display on the form.
tags?{ [string]: string }One or more key-value pairs to use when tagging the form data.

dataType

Type: IResolvable | FormDataTypeConfigProperty

The type of data source to use to create the form.


fields

Type: IResolvable | { [string]: IResolvable | FieldConfigProperty }

The configuration information for the form's fields.


formActionType

Type: string

Specifies whether to perform a create or update action on the form.


name

Type: string

The name of the form.


schemaVersion

Type: string

The schema version of the form.


sectionalElements

Type: IResolvable | { [string]: IResolvable | SectionalElementProperty }

The configuration information for the visual helper elements for the form.

These elements are not associated with any data.


style

Type: IResolvable | FormStyleProperty

The configuration for the form's style.


appId?

Type: string (optional)

The unique ID of the Amplify app associated with the form.


cta?

Type: IResolvable | FormCTAProperty (optional)

The FormCTA object that stores the call to action configuration for the form.


environmentName?

Type: string (optional)

The name of the backend environment that is a part of the Amplify app.


labelDecorator?

Type: string (optional)

Specifies an icon or decoration to display on the form.


tags?

Type: { [string]: string } (optional)

One or more key-value pairs to use when tagging the form data.