AWS::AmplifyUIBuilder::Form - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::AmplifyUIBuilder::Form

The AWS::AmplifyUIBuilder::Form resource specifies all of the information that is required to create a 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" : {Key: Value, ...},
      "FormActionType" : String,
      "LabelDecorator" : String,
      "Name" : String,
      "SchemaVersion" : String,
      "SectionalElements" : {Key: Value, ...},
      "Style" : FormStyle,
      "Tags" : {Key: Value, ...}
    }
}

YAML

Type: AWS::AmplifyUIBuilder::Form
Properties:
  AppId: String
  Cta: 
    FormCTA
  DataType: 
    FormDataTypeConfig
  EnvironmentName: String
  Fields: 
    Key: Value
  FormActionType: String
  LabelDecorator: String
  Name: String
  SchemaVersion: String
  SectionalElements: 
    Key: Value
  Style: 
    FormStyle
  Tags: 
    Key: Value

Properties

AppId

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

Required: No

Type: String

Update requires: Replacement

Cta

The FormCTA object that 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: No

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: Replacement

Fields

The configuration information for the form's fields.

Required: No

Type: Object of FieldConfig

Update requires: No interruption

FormActionType

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

Required: No

Type: String

Allowed values: create | update

Update requires: No interruption

LabelDecorator

Specifies an icon or decoration to display on the form.

Required: No

Type: String

Allowed values: required | optional | none

Update requires: No interruption

Name

The name of the form.

Required: No

Type: String

Minimum: 1

Maximum: 255

Update requires: No interruption

SchemaVersion

The schema version of the form.

Required: No

Type: String

Update requires: No interruption

SectionalElements

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

Required: No

Type: Object of SectionalElement

Update requires: No interruption

Style

The configuration for the form's style.

Required: No

Type: FormStyle

Update requires: No interruption

Tags

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

Required: No

Type: Object of String

Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Minimum: 1

Maximum: 256

Update requires: No interruption

Return values

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Id

The ID for the form.