Class: Aws::AmplifyUIBuilder::Types::Form

Inherits:

Struct

• Object
• Struct
• Aws::AmplifyUIBuilder::Types::Form

Defined in:

gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb

Overview

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #app_id ⇒ String

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

• #cta ⇒ Types::FormCTA

  Stores the call to action configuration for the form.

• #data_type ⇒ Types::FormDataTypeConfig

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

• #environment_name ⇒ String

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

• #fields ⇒ Hash<String,Types::FieldConfig>

  Stores the information about the form's fields.

• #form_action_type ⇒ String

  The operation to perform on the specified form.

• #id ⇒ String

  The unique ID of the form.

• #label_decorator ⇒ String

  Specifies an icon or decoration to display on the form.

• #name ⇒ String

  The name of the form.

• #schema_version ⇒ String

  The schema version of the form when it was imported.

• #sectional_elements ⇒ Hash<String,Types::SectionalElement>

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

• #style ⇒ Types::FormStyle

  Stores the configuration for the form's style.

• #tags ⇒ Hash<String,String>

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

Instance Attribute Details

#app_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 1891

class Form < Struct.new(
  :app_id,
  :environment_name,
  :id,
  :name,
  :form_action_type,
  :style,
  :data_type,
  :fields,
  :sectional_elements,
  :schema_version,
  :tags,
  :cta,
  :label_decorator)
  SENSITIVE = []
  include Aws::Structure
end

#cta ⇒ Types::FormCTA

Stores the call to action configuration for the form.

Returns:

• (Types::FormCTA)

# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 1891

class Form < Struct.new(
  :app_id,
  :environment_name,
  :id,
  :name,
  :form_action_type,
  :style,
  :data_type,
  :fields,
  :sectional_elements,
  :schema_version,
  :tags,
  :cta,
  :label_decorator)
  SENSITIVE = []
  include Aws::Structure
end

#data_type ⇒ Types::FormDataTypeConfig

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

Returns:

• (Types::FormDataTypeConfig)

# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 1891

class Form < Struct.new(
  :app_id,
  :environment_name,
  :id,
  :name,
  :form_action_type,
  :style,
  :data_type,
  :fields,
  :sectional_elements,
  :schema_version,
  :tags,
  :cta,
  :label_decorator)
  SENSITIVE = []
  include Aws::Structure
end

#environment_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 1891

class Form < Struct.new(
  :app_id,
  :environment_name,
  :id,
  :name,
  :form_action_type,
  :style,
  :data_type,
  :fields,
  :sectional_elements,
  :schema_version,
  :tags,
  :cta,
  :label_decorator)
  SENSITIVE = []
  include Aws::Structure
end

#fields ⇒ Hash<String,Types::FieldConfig>

Stores the information about the form's fields.

Returns:

• (Hash<String,Types::FieldConfig>)

# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 1891

class Form < Struct.new(
  :app_id,
  :environment_name,
  :id,
  :name,
  :form_action_type,
  :style,
  :data_type,
  :fields,
  :sectional_elements,
  :schema_version,
  :tags,
  :cta,
  :label_decorator)
  SENSITIVE = []
  include Aws::Structure
end

#form_action_type ⇒ String

The operation to perform on the specified form.

Returns:

• (String)

# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 1891

class Form < Struct.new(
  :app_id,
  :environment_name,
  :id,
  :name,
  :form_action_type,
  :style,
  :data_type,
  :fields,
  :sectional_elements,
  :schema_version,
  :tags,
  :cta,
  :label_decorator)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The unique ID of the form.

Returns:

• (String)

# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 1891

class Form < Struct.new(
  :app_id,
  :environment_name,
  :id,
  :name,
  :form_action_type,
  :style,
  :data_type,
  :fields,
  :sectional_elements,
  :schema_version,
  :tags,
  :cta,
  :label_decorator)
  SENSITIVE = []
  include Aws::Structure
end

#label_decorator ⇒ String

Specifies an icon or decoration to display on the form.

Returns:

• (String)

# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 1891

class Form < Struct.new(
  :app_id,
  :environment_name,
  :id,
  :name,
  :form_action_type,
  :style,
  :data_type,
  :fields,
  :sectional_elements,
  :schema_version,
  :tags,
  :cta,
  :label_decorator)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the form.

Returns:

• (String)

# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 1891

class Form < Struct.new(
  :app_id,
  :environment_name,
  :id,
  :name,
  :form_action_type,
  :style,
  :data_type,
  :fields,
  :sectional_elements,
  :schema_version,
  :tags,
  :cta,
  :label_decorator)
  SENSITIVE = []
  include Aws::Structure
end

#schema_version ⇒ String

The schema version of the form when it was imported.

Returns:

• (String)

# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 1891

class Form < Struct.new(
  :app_id,
  :environment_name,
  :id,
  :name,
  :form_action_type,
  :style,
  :data_type,
  :fields,
  :sectional_elements,
  :schema_version,
  :tags,
  :cta,
  :label_decorator)
  SENSITIVE = []
  include Aws::Structure
end

#sectional_elements ⇒ Hash<String,Types::SectionalElement>

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

Returns:

• (Hash<String,Types::SectionalElement>)

# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 1891

class Form < Struct.new(
  :app_id,
  :environment_name,
  :id,
  :name,
  :form_action_type,
  :style,
  :data_type,
  :fields,
  :sectional_elements,
  :schema_version,
  :tags,
  :cta,
  :label_decorator)
  SENSITIVE = []
  include Aws::Structure
end

#style ⇒ Types::FormStyle

Stores the configuration for the form's style.

Returns:

• (Types::FormStyle)

# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 1891

class Form < Struct.new(
  :app_id,
  :environment_name,
  :id,
  :name,
  :form_action_type,
  :style,
  :data_type,
  :fields,
  :sectional_elements,
  :schema_version,
  :tags,
  :cta,
  :label_decorator)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 1891

class Form < Struct.new(
  :app_id,
  :environment_name,
  :id,
  :name,
  :form_action_type,
  :style,
  :data_type,
  :fields,
  :sectional_elements,
  :schema_version,
  :tags,
  :cta,
  :label_decorator)
  SENSITIVE = []
  include Aws::Structure
end