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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#binding_propertiesTypes::ComponentPropertyBindingProperties

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



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 495

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

#bindingsHash<String,Types::FormBindingElement>

The information to bind the component property to form data.

Returns:



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 495

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

#collection_binding_propertiesTypes::ComponentPropertyBindingProperties

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



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 495

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

#component_nameString

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

Returns:

  • (String)


495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 495

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

#concatArray<Types::ComponentProperty>

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

Returns:



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 495

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

#conditionTypes::ComponentConditionProperty

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



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 495

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

#configuredBoolean

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

Returns:

  • (Boolean)


495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 495

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

#default_valueString

The default value to assign to the component property.

Returns:

  • (String)


495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 495

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

#eventString

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

Returns:

  • (String)


495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 495

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

#imported_valueString

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

Returns:

  • (String)


495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 495

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

#modelString

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

Returns:

  • (String)


495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 495

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

#propertyString

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

Returns:

  • (String)


495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 495

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

#typeString

The component type.

Returns:

  • (String)


495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 495

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

#user_attributeString

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

Returns:

  • (String)


495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 495

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

#valueString

The value to assign to the component property.

Returns:

  • (String)


495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 495

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