Class: Aws::AmplifyUIBuilder::Types::ComponentProperty

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb

Overview

Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#binding_properties ⇒ Types::ComponentPropertyBindingProperties

The information to bind the component property to data at runtime.

Returns:



917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
 
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 917

class ComponentProperty < Struct.new(
  :value,
  :binding_properties,
  :collection_binding_properties,
  :default_value,
  :model,
  :bindings,
  :event,
  :user_attribute,
  :concat,
  :condition,
  :configured,
  :type,
  :imported_value,
  :component_name,
  :property)
  SENSITIVE = []
  include Aws::Structure
end

#bindings ⇒ Hash<String,Types::FormBindingElement>

The information to bind the component property to form data.

Returns:



917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
 
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 917

class ComponentProperty < Struct.new(
  :value,
  :binding_properties,
  :collection_binding_properties,
  :default_value,
  :model,
  :bindings,
  :event,
  :user_attribute,
  :concat,
  :condition,
  :configured,
  :type,
  :imported_value,
  :component_name,
  :property)
  SENSITIVE = []
  include Aws::Structure
end

#collection_binding_properties ⇒ Types::ComponentPropertyBindingProperties

The information to bind the component property to data at runtime. Use this for collection components.

Returns:



917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
 
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 917

class ComponentProperty < Struct.new(
  :value,
  :binding_properties,
  :collection_binding_properties,
  :default_value,
  :model,
  :bindings,
  :event,
  :user_attribute,
  :concat,
  :condition,
  :configured,
  :type,
  :imported_value,
  :component_name,
  :property)
  SENSITIVE = []
  include Aws::Structure
end

#component_name ⇒ String

The name of the component that is affected by an event.

Returns:

  • (String) 


917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
 
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 917

class ComponentProperty < Struct.new(
  :value,
  :binding_properties,
  :collection_binding_properties,
  :default_value,
  :model,
  :bindings,
  :event,
  :user_attribute,
  :concat,
  :condition,
  :configured,
  :type,
  :imported_value,
  :component_name,
  :property)
  SENSITIVE = []
  include Aws::Structure
end

#concat ⇒ Array<Types::ComponentProperty>

A list of component properties to concatenate to create the value to assign to this component property.

Returns:



917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
 
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 917

class ComponentProperty < Struct.new(
  :value,
  :binding_properties,
  :collection_binding_properties,
  :default_value,
  :model,
  :bindings,
  :event,
  :user_attribute,
  :concat,
  :condition,
  :configured,
  :type,
  :imported_value,
  :component_name,
  :property)
  SENSITIVE = []
  include Aws::Structure
end

#condition ⇒ Types::ComponentConditionProperty

The conditional expression to use to assign a value to the component property.

Returns:



917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
 
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 917

class ComponentProperty < Struct.new(
  :value,
  :binding_properties,
  :collection_binding_properties,
  :default_value,
  :model,
  :bindings,
  :event,
  :user_attribute,
  :concat,
  :condition,
  :configured,
  :type,
  :imported_value,
  :component_name,
  :property)
  SENSITIVE = []
  include Aws::Structure
end

#configured ⇒ Boolean

Specifies whether the user configured the property in Amplify Studio after importing it.

Returns:

  • (Boolean) 


917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
 
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 917

class ComponentProperty < Struct.new(
  :value,
  :binding_properties,
  :collection_binding_properties,
  :default_value,
  :model,
  :bindings,
  :event,
  :user_attribute,
  :concat,
  :condition,
  :configured,
  :type,
  :imported_value,
  :component_name,
  :property)
  SENSITIVE = []
  include Aws::Structure
end

#default_value ⇒ String

The default value to assign to the component property.

Returns:

  • (String) 


917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
 
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 917

class ComponentProperty < Struct.new(
  :value,
  :binding_properties,
  :collection_binding_properties,
  :default_value,
  :model,
  :bindings,
  :event,
  :user_attribute,
  :concat,
  :condition,
  :configured,
  :type,
  :imported_value,
  :component_name,
  :property)
  SENSITIVE = []
  include Aws::Structure
end

#event ⇒ String

An event that occurs in your app. Use this for workflow data binding.

Returns:

  • (String) 


917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
 
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 917

class ComponentProperty < Struct.new(
  :value,
  :binding_properties,
  :collection_binding_properties,
  :default_value,
  :model,
  :bindings,
  :event,
  :user_attribute,
  :concat,
  :condition,
  :configured,
  :type,
  :imported_value,
  :component_name,
  :property)
  SENSITIVE = []
  include Aws::Structure
end

#imported_value ⇒ String

The default value assigned to the property when the component is imported into an app.

Returns:

  • (String) 


917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
 
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 917

class ComponentProperty < Struct.new(
  :value,
  :binding_properties,
  :collection_binding_properties,
  :default_value,
  :model,
  :bindings,
  :event,
  :user_attribute,
  :concat,
  :condition,
  :configured,
  :type,
  :imported_value,
  :component_name,
  :property)
  SENSITIVE = []
  include Aws::Structure
end

#model ⇒ String

The data model to use to assign a value to the component property.

Returns:

  • (String) 


917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
 
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 917

class ComponentProperty < Struct.new(
  :value,
  :binding_properties,
  :collection_binding_properties,
  :default_value,
  :model,
  :bindings,
  :event,
  :user_attribute,
  :concat,
  :condition,
  :configured,
  :type,
  :imported_value,
  :component_name,
  :property)
  SENSITIVE = []
  include Aws::Structure
end

#property ⇒ String

The name of the component's property that is affected by an event.

Returns:

  • (String) 


917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
 
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 917

class ComponentProperty < Struct.new(
  :value,
  :binding_properties,
  :collection_binding_properties,
  :default_value,
  :model,
  :bindings,
  :event,
  :user_attribute,
  :concat,
  :condition,
  :configured,
  :type,
  :imported_value,
  :component_name,
  :property)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The component type.

Returns:

  • (String) 


917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
 
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 917

class ComponentProperty < Struct.new(
  :value,
  :binding_properties,
  :collection_binding_properties,
  :default_value,
  :model,
  :bindings,
  :event,
  :user_attribute,
  :concat,
  :condition,
  :configured,
  :type,
  :imported_value,
  :component_name,
  :property)
  SENSITIVE = []
  include Aws::Structure
end

#user_attribute ⇒ String

An authenticated user attribute to use to assign a value to the component property.

Returns:

  • (String) 


917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
 
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 917

class ComponentProperty < Struct.new(
  :value,
  :binding_properties,
  :collection_binding_properties,
  :default_value,
  :model,
  :bindings,
  :event,
  :user_attribute,
  :concat,
  :condition,
  :configured,
  :type,
  :imported_value,
  :component_name,
  :property)
  SENSITIVE = []
  include Aws::Structure
end

#value ⇒ String

The value to assign to the component property.

Returns:

  • (String) 


917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
 
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 917

class ComponentProperty < Struct.new(
  :value,
  :binding_properties,
  :collection_binding_properties,
  :default_value,
  :model,
  :bindings,
  :event,
  :user_attribute,
  :concat,
  :condition,
  :configured,
  :type,
  :imported_value,
  :component_name,
  :property)
  SENSITIVE = []
  include Aws::Structure
end