Struct aws_sdk_amplifyuibuilder::types::Form

#[non_exhaustive]
pub struct Form {

    pub app_id: String,
    pub environment_name: String,
    pub id: String,
    pub name: String,
    pub form_action_type: FormActionType,
    pub style: Option<FormStyle>,
    pub data_type: Option<FormDataTypeConfig>,
    pub fields: HashMap<String, FieldConfig>,
    pub sectional_elements: HashMap<String, SectionalElement>,
    pub schema_version: String,
    pub tags: Option<HashMap<String, String>>,
    pub cta: Option<FormCta>,
    pub label_decorator: Option<LabelDecorator>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

app_id: String

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

environment_name: String

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

id: String

The unique ID of the form.

name: String

The name of the form.

form_action_type: FormActionType

The operation to perform on the specified form.

style: Option<FormStyle>

Stores the configuration for the form's style.

data_type: Option<FormDataTypeConfig>

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

fields: HashMap<String, FieldConfig>

Stores the information about the form's fields.

sectional_elements: HashMap<String, SectionalElement>

Stores the visual helper elements for the form that are not associated with any data.

schema_version: String

The schema version of the form when it was imported.

tags: Option<HashMap<String, String>>

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

cta: Option<FormCta>

Stores the call to action configuration for the form.

label_decorator: Option<LabelDecorator>

Specifies an icon or decoration to display on the form.

Implementations

impl Form

pub fn app_id(&self) -> &str

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

pub fn environment_name(&self) -> &str

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

pub fn id(&self) -> &str

The unique ID of the form.

pub fn name(&self) -> &str

The name of the form.

pub fn form_action_type(&self) -> &FormActionType

The operation to perform on the specified form.

pub fn style(&self) -> Option<&FormStyle>

Stores the configuration for the form's style.

pub fn data_type(&self) -> Option<&FormDataTypeConfig>

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

pub fn fields(&self) -> &HashMap<String, FieldConfig>

Stores the information about the form's fields.

pub fn sectional_elements(&self) -> &HashMap<String, SectionalElement>

Stores the visual helper elements for the form that are not associated with any data.

pub fn schema_version(&self) -> &str

The schema version of the form when it was imported.

pub fn tags(&self) -> Option<&HashMap<String, String>>

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

pub fn cta(&self) -> Option<&FormCta>

Stores the call to action configuration for the form.

pub fn label_decorator(&self) -> Option<&LabelDecorator>

Specifies an icon or decoration to display on the form.

impl Form

pub fn builder() -> FormBuilder

Creates a new builder-style object to manufacture Form.

Trait Implementations

impl Clone for Form

fn clone(&self) -> Form

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Form

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Form

fn eq(&self, other: &Form) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Form