AWS::AmplifyUIBuilder::Form
Contains the configuration settings for a Form
user interface (UI) element
for an Amplify app. A form is a component you can add to your project by specifying a data
source as the default configuration for the form.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::AmplifyUIBuilder::Form", "Properties" : { "AppId" :
String
, "Cta" :FormCTA
, "DataType" :FormDataTypeConfig
, "EnvironmentName" :String
, "Fields" :{
, "FormActionType" :Key
:Value
, ...}String
, "Name" :String
, "SchemaVersion" :String
, "SectionalElements" :{
, "Style" :Key
:Value
, ...}FormStyle
, "Tags" :{
} }Key
:Value
, ...}
YAML
Type: AWS::AmplifyUIBuilder::Form Properties: AppId:
String
Cta:FormCTA
DataType:FormDataTypeConfig
EnvironmentName:String
Fields:FormActionType:
Key
:Value
String
Name:String
SchemaVersion:String
SectionalElements:Style:
Key
:Value
FormStyle
Tags:
Key
:Value
Properties
AppId
-
The unique ID of the Amplify app associated with the form.
Required: No
Type: String
Update requires: No interruption
Cta
-
Stores the call to action configuration for the form.
Required: No
Type: FormCTA
Update requires: No interruption
DataType
-
The type of data source to use to create the form.
Required: Yes
Type: FormDataTypeConfig
Update requires: No interruption
EnvironmentName
-
The name of the backend environment that is a part of the Amplify app.
Required: No
Type: String
Update requires: No interruption
Fields
-
Stores the information about the form's fields.
Required: Yes
Type: Map of FieldConfig
Update requires: No interruption
FormActionType
-
The operation to perform on the specified form.
Required: Yes
Type: String
Update requires: No interruption
Name
-
The name of the form.
Required: Yes
Type: String
Update requires: No interruption
SchemaVersion
-
The schema version of the form when it was imported.
Required: Yes
Type: String
Update requires: No interruption
SectionalElements
-
Stores the visual helper elements for the form that are not associated with any data.
Required: Yes
Type: Map of SectionalElement
Update requires: No interruption
Style
-
Stores the configuration for the form's style.
Required: Yes
Type: FormStyle
Update requires: No interruption
Tags
-
One or more key-value pairs to use when tagging the form.
Required: No
Type: Map of String
Update requires: Replacement