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

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

Overview

Note:

When making an API call, you may pass ComponentProperty data as a hash:

{
  binding_properties: {
    field: "String",
    property: "String", # required
  },
  bindings: {
    "String" => {
      element: "String", # required
      property: "String", # required
    },
  },
  collection_binding_properties: {
    field: "String",
    property: "String", # required
  },
  component_name: "String",
  concat: [
    {
      binding_properties: {
        field: "String",
        property: "String", # required
      },
      bindings: {
        "String" => {
          element: "String", # required
          property: "String", # required
        },
      },
      collection_binding_properties: {
        field: "String",
        property: "String", # required
      },
      component_name: "String",
      concat: {
        # recursive ComponentPropertyList
      },
      condition: {
        else: {
          # recursive ComponentProperty
        },
        field: "String",
        operand: "String",
        operand_type: "String",
        operator: "String",
        property: "String",
        then: {
          # recursive ComponentProperty
        },
      },
      configured: false,
      default_value: "String",
      event: "String",
      imported_value: "String",
      model: "String",
      property: "String",
      type: "String",
      user_attribute: "String",
      value: "String",
    },
  ],
  condition: {
    else: {
      binding_properties: {
        field: "String",
        property: "String", # required
      },
      bindings: {
        "String" => {
          element: "String", # required
          property: "String", # required
        },
      },
      collection_binding_properties: {
        field: "String",
        property: "String", # required
      },
      component_name: "String",
      concat: [
        {
          # recursive ComponentProperty
        },
      ],
      condition: {
        # recursive ComponentConditionProperty
      },
      configured: false,
      default_value: "String",
      event: "String",
      imported_value: "String",
      model: "String",
      property: "String",
      type: "String",
      user_attribute: "String",
      value: "String",
    },
    field: "String",
    operand: "String",
    operand_type: "String",
    operator: "String",
    property: "String",
    then: {
      binding_properties: {
        field: "String",
        property: "String", # required
      },
      bindings: {
        "String" => {
          element: "String", # required
          property: "String", # required
        },
      },
      collection_binding_properties: {
        field: "String",
        property: "String", # required
      },
      component_name: "String",
      concat: [
        {
          # recursive ComponentProperty
        },
      ],
      condition: {
        # recursive ComponentConditionProperty
      },
      configured: false,
      default_value: "String",
      event: "String",
      imported_value: "String",
      model: "String",
      property: "String",
      type: "String",
      user_attribute: "String",
      value: "String",
    },
  },
  configured: false,
  default_value: "String",
  event: "String",
  imported_value: "String",
  model: "String",
  property: "String",
  type: "String",
  user_attribute: "String",
  value: "String",
}

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.



2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 2400

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:



2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 2400

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.



2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 2400

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)


2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 2400

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:



2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 2400

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.



2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 2400

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)


2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 2400

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)


2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 2400

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)


2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 2400

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)


2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 2400

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)


2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 2400

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)


2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 2400

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)


2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 2400

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)


2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 2400

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)


2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 2400

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