Class: Aws::AmplifyUIBuilder::Types::FieldInputConfig

Inherits:

Struct

• Object
• Struct
• Aws::AmplifyUIBuilder::Types::FieldInputConfig

Defined in:

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

Overview

Describes the configuration for the default input values to display for a field.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #default_checked ⇒ Boolean

  Specifies whether a field has a default value.

• #default_country_code ⇒ String

  The default country code for a phone number.

• #default_value ⇒ String

  The default value for the field.

• #descriptive_text ⇒ String

  The text to display to describe the field.

• #file_uploader_config ⇒ Types::FileUploaderFieldConfig

  The configuration for the file uploader field.

• #is_array ⇒ Boolean

  Specifies whether to render the field as an array.

• #max_value ⇒ Float

  The maximum value to display for the field.

• #min_value ⇒ Float

  The minimum value to display for the field.

• #name ⇒ String

  The name of the field.

• #placeholder ⇒ String

  The text to display as a placeholder for the field.

• #read_only ⇒ Boolean

  Specifies a read only field.

• #required ⇒ Boolean

  Specifies a field that requires input.

• #step ⇒ Float

  The stepping increment for a numeric value in a field.

• #type ⇒ String

  The input type for the field.

• #value ⇒ String

  The value for the field.

• #value_mappings ⇒ Types::ValueMappings

  The information to use to customize the input fields with data at runtime.

Instance Attribute Details

#default_checked ⇒ Boolean

Specifies whether a field has a default value.

Returns:

• (Boolean)

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

class FieldInputConfig < Struct.new(
  :type,
  :required,
  :read_only,
  :placeholder,
  :default_value,
  :descriptive_text,
  :default_checked,
  :default_country_code,
  :value_mappings,
  :name,
  :min_value,
  :max_value,
  :step,
  :value,
  :is_array,
  :file_uploader_config)
  SENSITIVE = []
  include Aws::Structure
end

#default_country_code ⇒ String

The default country code for a phone number.

Returns:

• (String)

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

class FieldInputConfig < Struct.new(
  :type,
  :required,
  :read_only,
  :placeholder,
  :default_value,
  :descriptive_text,
  :default_checked,
  :default_country_code,
  :value_mappings,
  :name,
  :min_value,
  :max_value,
  :step,
  :value,
  :is_array,
  :file_uploader_config)
  SENSITIVE = []
  include Aws::Structure
end

#default_value ⇒ String

The default value for the field.

Returns:

• (String)

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

class FieldInputConfig < Struct.new(
  :type,
  :required,
  :read_only,
  :placeholder,
  :default_value,
  :descriptive_text,
  :default_checked,
  :default_country_code,
  :value_mappings,
  :name,
  :min_value,
  :max_value,
  :step,
  :value,
  :is_array,
  :file_uploader_config)
  SENSITIVE = []
  include Aws::Structure
end

#descriptive_text ⇒ String

The text to display to describe the field.

Returns:

• (String)

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

class FieldInputConfig < Struct.new(
  :type,
  :required,
  :read_only,
  :placeholder,
  :default_value,
  :descriptive_text,
  :default_checked,
  :default_country_code,
  :value_mappings,
  :name,
  :min_value,
  :max_value,
  :step,
  :value,
  :is_array,
  :file_uploader_config)
  SENSITIVE = []
  include Aws::Structure
end

#file_uploader_config ⇒ Types::FileUploaderFieldConfig

The configuration for the file uploader field.

Returns:

• (Types::FileUploaderFieldConfig)

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

class FieldInputConfig < Struct.new(
  :type,
  :required,
  :read_only,
  :placeholder,
  :default_value,
  :descriptive_text,
  :default_checked,
  :default_country_code,
  :value_mappings,
  :name,
  :min_value,
  :max_value,
  :step,
  :value,
  :is_array,
  :file_uploader_config)
  SENSITIVE = []
  include Aws::Structure
end

#is_array ⇒ Boolean

Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.

Returns:

• (Boolean)

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

class FieldInputConfig < Struct.new(
  :type,
  :required,
  :read_only,
  :placeholder,
  :default_value,
  :descriptive_text,
  :default_checked,
  :default_country_code,
  :value_mappings,
  :name,
  :min_value,
  :max_value,
  :step,
  :value,
  :is_array,
  :file_uploader_config)
  SENSITIVE = []
  include Aws::Structure
end

#max_value ⇒ Float

The maximum value to display for the field.

Returns:

• (Float)

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

class FieldInputConfig < Struct.new(
  :type,
  :required,
  :read_only,
  :placeholder,
  :default_value,
  :descriptive_text,
  :default_checked,
  :default_country_code,
  :value_mappings,
  :name,
  :min_value,
  :max_value,
  :step,
  :value,
  :is_array,
  :file_uploader_config)
  SENSITIVE = []
  include Aws::Structure
end

#min_value ⇒ Float

The minimum value to display for the field.

Returns:

• (Float)

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

class FieldInputConfig < Struct.new(
  :type,
  :required,
  :read_only,
  :placeholder,
  :default_value,
  :descriptive_text,
  :default_checked,
  :default_country_code,
  :value_mappings,
  :name,
  :min_value,
  :max_value,
  :step,
  :value,
  :is_array,
  :file_uploader_config)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the field.

Returns:

• (String)

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

class FieldInputConfig < Struct.new(
  :type,
  :required,
  :read_only,
  :placeholder,
  :default_value,
  :descriptive_text,
  :default_checked,
  :default_country_code,
  :value_mappings,
  :name,
  :min_value,
  :max_value,
  :step,
  :value,
  :is_array,
  :file_uploader_config)
  SENSITIVE = []
  include Aws::Structure
end

#placeholder ⇒ String

The text to display as a placeholder for the field.

Returns:

• (String)

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

class FieldInputConfig < Struct.new(
  :type,
  :required,
  :read_only,
  :placeholder,
  :default_value,
  :descriptive_text,
  :default_checked,
  :default_country_code,
  :value_mappings,
  :name,
  :min_value,
  :max_value,
  :step,
  :value,
  :is_array,
  :file_uploader_config)
  SENSITIVE = []
  include Aws::Structure
end

#read_only ⇒ Boolean

Specifies a read only field.

Returns:

• (Boolean)

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

class FieldInputConfig < Struct.new(
  :type,
  :required,
  :read_only,
  :placeholder,
  :default_value,
  :descriptive_text,
  :default_checked,
  :default_country_code,
  :value_mappings,
  :name,
  :min_value,
  :max_value,
  :step,
  :value,
  :is_array,
  :file_uploader_config)
  SENSITIVE = []
  include Aws::Structure
end

#required ⇒ Boolean

Specifies a field that requires input.

Returns:

• (Boolean)

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

class FieldInputConfig < Struct.new(
  :type,
  :required,
  :read_only,
  :placeholder,
  :default_value,
  :descriptive_text,
  :default_checked,
  :default_country_code,
  :value_mappings,
  :name,
  :min_value,
  :max_value,
  :step,
  :value,
  :is_array,
  :file_uploader_config)
  SENSITIVE = []
  include Aws::Structure
end

#step ⇒ Float

The stepping increment for a numeric value in a field.

Returns:

• (Float)

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

class FieldInputConfig < Struct.new(
  :type,
  :required,
  :read_only,
  :placeholder,
  :default_value,
  :descriptive_text,
  :default_checked,
  :default_country_code,
  :value_mappings,
  :name,
  :min_value,
  :max_value,
  :step,
  :value,
  :is_array,
  :file_uploader_config)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The input type for the field.

Returns:

• (String)

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

class FieldInputConfig < Struct.new(
  :type,
  :required,
  :read_only,
  :placeholder,
  :default_value,
  :descriptive_text,
  :default_checked,
  :default_country_code,
  :value_mappings,
  :name,
  :min_value,
  :max_value,
  :step,
  :value,
  :is_array,
  :file_uploader_config)
  SENSITIVE = []
  include Aws::Structure
end

#value ⇒ String

The value for the field.

Returns:

• (String)

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

class FieldInputConfig < Struct.new(
  :type,
  :required,
  :read_only,
  :placeholder,
  :default_value,
  :descriptive_text,
  :default_checked,
  :default_country_code,
  :value_mappings,
  :name,
  :min_value,
  :max_value,
  :step,
  :value,
  :is_array,
  :file_uploader_config)
  SENSITIVE = []
  include Aws::Structure
end

#value_mappings ⇒ Types::ValueMappings

The information to use to customize the input fields with data at runtime.

Returns:

• (Types::ValueMappings)

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

class FieldInputConfig < Struct.new(
  :type,
  :required,
  :read_only,
  :placeholder,
  :default_value,
  :descriptive_text,
  :default_checked,
  :default_country_code,
  :value_mappings,
  :name,
  :min_value,
  :max_value,
  :step,
  :value,
  :is_array,
  :file_uploader_config)
  SENSITIVE = []
  include Aws::Structure
end