Amazonka.AmplifyUiBuilder.Types.CreateFormData

Documentation

data CreateFormData

Represents all of the information that is required to create a form.

See: newCreateFormData smart constructor.

Constructors

CreateFormData'

Fields

• cta :: Maybe FormCTA

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

• tags :: Maybe (HashMap Text Text)

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

• dataType :: FormDataTypeConfig

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

• fields :: HashMap Text FieldConfig

  The configuration information for the form's fields.

• formActionType :: FormActionType

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

• name :: Text

  The name of the form.

• schemaVersion :: Text

  The schema version of the form.

• sectionalElements :: HashMap Text SectionalElement

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

• style :: FormStyle

  The configuration for the form's style.

Instances

ToJSON CreateFormData

Defined in Amazonka.AmplifyUiBuilder.Types.CreateFormData

Methods

toJSON :: CreateFormData -> Value

toEncoding :: CreateFormData -> Encoding

toJSONList :: [CreateFormData] -> Value

toEncodingList :: [CreateFormData] -> Encoding

Generic CreateFormData

Defined in Amazonka.AmplifyUiBuilder.Types.CreateFormData

Associated Types

type Rep CreateFormData :: Type -> Type

Methods

from :: CreateFormData -> Rep CreateFormData x

to :: Rep CreateFormData x -> CreateFormData

Read CreateFormData

Defined in Amazonka.AmplifyUiBuilder.Types.CreateFormData

Methods

readsPrec :: Int -> ReadS CreateFormData

readList :: ReadS [CreateFormData]

readPrec :: ReadPrec CreateFormData

readListPrec :: ReadPrec [CreateFormData]

Show CreateFormData

Defined in Amazonka.AmplifyUiBuilder.Types.CreateFormData

Methods

showsPrec :: Int -> CreateFormData -> ShowS

show :: CreateFormData -> String

showList :: [CreateFormData] -> ShowS

NFData CreateFormData

Defined in Amazonka.AmplifyUiBuilder.Types.CreateFormData

Methods

rnf :: CreateFormData -> ()

Eq CreateFormData

Defined in Amazonka.AmplifyUiBuilder.Types.CreateFormData

Methods

(==) :: CreateFormData -> CreateFormData -> Bool

(/=) :: CreateFormData -> CreateFormData -> Bool

Hashable CreateFormData

Defined in Amazonka.AmplifyUiBuilder.Types.CreateFormData

Methods

hashWithSalt :: Int -> CreateFormData -> Int

hash :: CreateFormData -> Int

type Rep CreateFormData

Defined in Amazonka.AmplifyUiBuilder.Types.CreateFormData

type Rep CreateFormData = D1 ('MetaData "CreateFormData" "Amazonka.AmplifyUiBuilder.Types.CreateFormData" "amazonka-amplifyuibuilder-2.0-KN0MRaPu7dZCAXr3ruBTcC" 'False) (C1 ('MetaCons "CreateFormData'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cta") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FormCTA)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "dataType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FormDataTypeConfig) :*: S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text FieldConfig)))) :*: ((S1 ('MetaSel ('Just "formActionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FormActionType) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "schemaVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "sectionalElements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text SectionalElement)) :*: S1 ('MetaSel ('Just "style") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FormStyle))))))

newCreateFormData

Arguments

:: FormDataTypeConfig

$sel:dataType:CreateFormData'

-> FormActionType

$sel:formActionType:CreateFormData'

-> Text

$sel:name:CreateFormData'

-> Text

$sel:schemaVersion:CreateFormData'

-> FormStyle

$sel:style:CreateFormData'

-> CreateFormData

Create a value of CreateFormData with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cta:CreateFormData', createFormData_cta - The FormCTA object that stores the call to action configuration for the form.

$sel:tags:CreateFormData', createFormData_tags - One or more key-value pairs to use when tagging the form data.

$sel:dataType:CreateFormData', createFormData_dataType - The type of data source to use to create the form.

$sel:fields:CreateFormData', createFormData_fields - The configuration information for the form's fields.

$sel:formActionType:CreateFormData', createFormData_formActionType - Specifies whether to perform a create or update action on the form.

$sel:name:CreateFormData', createFormData_name - The name of the form.

$sel:schemaVersion:CreateFormData', createFormData_schemaVersion - The schema version of the form.

$sel:sectionalElements:CreateFormData', createFormData_sectionalElements - The configuration information for the visual helper elements for the form. These elements are not associated with any data.

$sel:style:CreateFormData', createFormData_style - The configuration for the form's style.

createFormData_cta :: Lens' CreateFormData (Maybe FormCTA)

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

createFormData_tags :: Lens' CreateFormData (Maybe (HashMap Text Text))

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

createFormData_dataType :: Lens' CreateFormData FormDataTypeConfig

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

createFormData_fields :: Lens' CreateFormData (HashMap Text FieldConfig)

The configuration information for the form's fields.

createFormData_formActionType :: Lens' CreateFormData FormActionType

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

createFormData_name :: Lens' CreateFormData Text

The name of the form.

createFormData_schemaVersion :: Lens' CreateFormData Text

The schema version of the form.

createFormData_sectionalElements :: Lens' CreateFormData (HashMap Text SectionalElement)

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

createFormData_style :: Lens' CreateFormData FormStyle

The configuration for the form's style.