forms

Creates, updates, deletes or gets a form resource or lists forms in a region

Overview

Name	forms
Type	Resource
Description	Definition of AWS::AmplifyUIBuilder::Form Resource Type
Id	aws.amplifyuibuilder.forms

Fields

Name	Datatype	Description
app_id	string
cta	object
data_type	object
environment_name	string
fields	object
form_action_type	string
id	string
label_decorator	string
name	string
schema_version	string
sectional_elements	object
style	object
tags	object
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all forms in a region.

SELECT
region,
app_id,
cta,
data_type,
environment_name,
fields,
form_action_type,
id,
label_decorator,
name,
schema_version,
sectional_elements,
style,
tags
FROM aws.amplifyuibuilder.forms
WHERE region = 'us-east-1';

Gets all properties from an individual form.

SELECT
region,
app_id,
cta,
data_type,
environment_name,
fields,
form_action_type,
id,
label_decorator,
name,
schema_version,
sectional_elements,
style,
tags
FROM aws.amplifyuibuilder.forms
WHERE region = 'us-east-1' AND data__Identifier = '<AppId>|<EnvironmentName>|<Id>';

INSERT example

Use the following StackQL query and manifest file to create a new form resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.amplifyuibuilder.forms (
 AppId,
 Cta,
 DataType,
 EnvironmentName,
 Fields,
 FormActionType,
 LabelDecorator,
 Name,
 SchemaVersion,
 SectionalElements,
 Style,
 Tags,
 region
)
SELECT 
'{{ AppId }}',
 '{{ Cta }}',
 '{{ DataType }}',
 '{{ EnvironmentName }}',
 '{{ Fields }}',
 '{{ FormActionType }}',
 '{{ LabelDecorator }}',
 '{{ Name }}',
 '{{ SchemaVersion }}',
 '{{ SectionalElements }}',
 '{{ Style }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.amplifyuibuilder.forms (
 AppId,
 Cta,
 DataType,
 EnvironmentName,
 Fields,
 FormActionType,
 LabelDecorator,
 Name,
 SchemaVersion,
 SectionalElements,
 Style,
 Tags,
 region
)
SELECT 
 '{{ AppId }}',
 '{{ Cta }}',
 '{{ DataType }}',
 '{{ EnvironmentName }}',
 '{{ Fields }}',
 '{{ FormActionType }}',
 '{{ LabelDecorator }}',
 '{{ Name }}',
 '{{ SchemaVersion }}',
 '{{ SectionalElements }}',
 '{{ Style }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: form
    props:
      - name: AppId
        value: '{{ AppId }}'
      - name: Cta
        value:
          Position: '{{ Position }}'
          Clear:
            Excluded: '{{ Excluded }}'
            Children: '{{ Children }}'
            Position: null
          Cancel: null
          Submit: null
      - name: DataType
        value:
          DataSourceType: '{{ DataSourceType }}'
          DataTypeName: '{{ DataTypeName }}'
      - name: EnvironmentName
        value: '{{ EnvironmentName }}'
      - name: Fields
        value: {}
      - name: FormActionType
        value: '{{ FormActionType }}'
      - name: LabelDecorator
        value: '{{ LabelDecorator }}'
      - name: Name
        value: '{{ Name }}'
      - name: SchemaVersion
        value: '{{ SchemaVersion }}'
      - name: SectionalElements
        value: {}
      - name: Style
        value:
          HorizontalGap: null
          VerticalGap: null
          OuterPadding: null
      - name: Tags
        value: {}

DELETE example

/*+ delete */
DELETE FROM aws.amplifyuibuilder.forms
WHERE data__Identifier = '<AppId|EnvironmentName|Id>'
AND region = 'us-east-1';

Permissions

To operate on the forms resource, the following permissions are required:

Create

amplify:GetApp,
amplifyuibuilder:CreateForm,
amplifyuibuilder:GetForm,
amplifyuibuilder:TagResource,
amplifyuibuilder:UntagResource

Read

amplify:GetApp,
amplifyuibuilder:GetForm,
amplifyuibuilder:TagResource

Update

amplify:GetApp,
amplifyuibuilder:GetForm,
amplifyuibuilder:TagResource,
amplifyuibuilder:UntagResource,
amplifyuibuilder:UpdateForm

Delete

amplify:GetApp,
amplifyuibuilder:DeleteForm,
amplifyuibuilder:TagResource,
amplifyuibuilder:UntagResource

List

amplify:GetApp,
amplifyuibuilder:ListForms