class CfnFormPropsMixin

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.AmplifyUIBuilder.CfnFormPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsamplifyuibuilder#CfnFormPropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.amplifyuibuilder.CfnFormPropsMixin
Python	aws_cdk.cfn_property_mixins.aws_amplifyuibuilder.CfnFormPropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_amplifyuibuilder » CfnFormPropsMixin

Implements IMixin

Extends Mixin

The AWS::AmplifyUIBuilder::Form resource specifies all of the information that is required to create a form.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html

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/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const formInputValuePropertyProperty_: amplifyuibuilder.CfnFormPropsMixin.FormInputValuePropertyProperty;
declare const mergeStrategy: cdk.IMergeStrategy;
const cfnFormPropsMixin = new amplifyuibuilder.CfnFormPropsMixin({
  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',
      },
    },
  },
  dataType: {
    dataSourceType: 'dataSourceType',
    dataTypeName: 'dataTypeName',
  },
  environmentName: 'environmentName',
  fields: {
    fieldsKey: {
      excluded: false,
      inputType: {
        defaultChecked: false,
        defaultCountryCode: 'defaultCountryCode',
        defaultValue: 'defaultValue',
        descriptiveText: 'descriptiveText',
        fileUploaderConfig: {
          acceptedFileTypes: ['acceptedFileTypes'],
          accessLevel: 'accessLevel',
          isResumable: false,
          maxFileCount: 123,
          maxSize: 123,
          showThumbnails: false,
        },
        isArray: false,
        maxValue: 123,
        minValue: 123,
        name: 'name',
        placeholder: 'placeholder',
        readOnly: false,
        required: false,
        step: 123,
        type: 'type',
        value: 'value',
        valueMappings: {
          bindingProperties: {
            bindingPropertiesKey: {
              bindingProperties: {
                model: 'model',
              },
              type: 'type',
            },
          },
          values: [{
            displayValue: {
              bindingProperties: {
                field: 'field',
                property: 'property',
              },
              concat: [formInputValuePropertyProperty_],
              value: 'value',
            },
            value: {
              bindingProperties: {
                field: 'field',
                property: 'property',
              },
              concat: [formInputValuePropertyProperty_],
              value: 'value',
            },
          }],
        },
      },
      label: 'label',
      position: {
        below: 'below',
        fixed: 'fixed',
        rightOf: 'rightOf',
      },
      validations: [{
        numValues: [123],
        strValues: ['strValues'],
        type: 'type',
        validationMessage: 'validationMessage',
      }],
    },
  },
  formActionType: 'formActionType',
  labelDecorator: 'labelDecorator',
  name: 'name',
  schemaVersion: 'schemaVersion',
  sectionalElements: {
    sectionalElementsKey: {
      excluded: false,
      level: 123,
      orientation: 'orientation',
      position: {
        below: 'below',
        fixed: 'fixed',
        rightOf: 'rightOf',
      },
      text: 'text',
      type: 'type',
    },
  },
  style: {
    horizontalGap: {
      tokenReference: 'tokenReference',
      value: 'value',
    },
    outerPadding: {
      tokenReference: 'tokenReference',
      value: 'value',
    },
    verticalGap: {
      tokenReference: 'tokenReference',
      value: 'value',
    },
  },
  tags: {
    tagsKey: 'tags',
  },
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnFormPropsMixin(props: CfnFormMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnFormMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::AmplifyUIBuilder::Form.

Properties

Name	Type	Description
props	CfnFormMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnFormMixinProps

---

strategy

Type: IMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.