AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::AmplifyUIBuilder::Form

CfnForm

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

Import

import { CfnForm } from 'aws-cdk-lib/aws-amplifyuibuilder';

Or use the module namespace:

import * as amplifyuibuilder from 'aws-cdk-lib/aws-amplifyuibuilder';
// amplifyuibuilder.CfnForm

Properties

Configuration passed to the constructor as CfnFormProps.

appIdOptional
string

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

ctaOptional
IResolvable | FormCTAProperty

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

dataTypeOptional
IResolvable | FormDataTypeConfigProperty

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

environmentNameOptional
string

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

fieldsOptional
IResolvable | { [key: string]: IResolvable | FieldConfigProperty }

The configuration information for the form's fields.

formActionTypeOptional
string

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

labelDecoratorOptional
string

Specifies an icon or decoration to display on the form.

nameOptional
string

The name of the form.

schemaVersionOptional
string

The schema version of the form.

sectionalElementsOptional
IResolvable | { [key: string]: IResolvable | SectionalElementProperty }

The configuration information for the visual helper elements for the form. These elements are not associated with any data.

styleOptional
IResolvable | FormStyleProperty

The configuration for the form's style.

tagsOptional
{ [key: string]: string }

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

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::AmplifyUIBuilder::FormView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-amplifyuibuilder
CFN TypeAWS::AmplifyUIBuilder::Form
Properties12

Related Constructs

Explore This Service

External Links