Class: Aws::AmplifyUIBuilder::Types::UpdateComponentData

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 UpdateComponentData data as a hash:

{
  binding_properties: {
    "String" => {
      binding_properties: {
        bucket: "String",
        default_value: "String",
        field: "String",
        key: "String",
        model: "String",
        predicates: [
          {
            and: {
              # recursive PredicateList
            },
            field: "String",
            operand: "String",
            operator: "String",
            or: {
              # recursive PredicateList
            },
          },
        ],
        user_attribute: "String",
      },
      default_value: "String",
      type: "String",
    },
  },
  children: [
    {
      children: {
        # recursive ComponentChildList
      },
      component_type: "String", # required
      events: {
        "String" => {
          action: "String",
          binding_event: "String",
          parameters: {
            anchor: {
              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: {
                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",
            },
            fields: {
              "String" => {
                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: {
                  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",
              },
            },
            global: {
              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: {
                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",
            },
            id: {
              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: {
                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",
            },
            model: "String",
            state: {
              component_name: "String", # required
              property: "String", # required
              set: { # required
                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: {
                  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",
              },
            },
            target: {
              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: {
                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",
            },
            type: {
              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: {
                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",
            },
            url: {
              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: {
                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",
            },
          },
        },
      },
      name: "String", # required
      properties: { # required
        "String" => {
          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: {
            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",
        },
      },
      source_id: "String",
    },
  ],
  collection_properties: {
    "String" => {
      identifiers: ["String"],
      model: "String", # required
      predicate: {
        and: [
          {
            # recursive Predicate
          },
        ],
        field: "String",
        operand: "String",
        operator: "String",
        or: [
          {
            # recursive Predicate
          },
        ],
      },
      sort: [
        {
          direction: "ASC", # required, accepts ASC, DESC
          field: "String", # required
        },
      ],
    },
  },
  component_type: "ComponentType",
  events: {
    "String" => {
      action: "String",
      binding_event: "String",
      parameters: {
        anchor: {
          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: {
            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",
        },
        fields: {
          "String" => {
            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: {
              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",
          },
        },
        global: {
          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: {
            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",
        },
        id: {
          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: {
            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",
        },
        model: "String",
        state: {
          component_name: "String", # required
          property: "String", # required
          set: { # required
            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: {
              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",
          },
        },
        target: {
          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: {
            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",
        },
        type: {
          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: {
            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",
        },
        url: {
          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: {
            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",
        },
      },
    },
  },
  id: "Uuid",
  name: "ComponentName",
  overrides: {
    "String" => {
      "String" => "String",
    },
  },
  properties: {
    "String" => {
      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: {
        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",
    },
  },
  schema_version: "String",
  source_id: "String",
  variants: [
    {
      overrides: {
        "String" => {
          "String" => "String",
        },
      },
      variant_values: {
        "String" => "String",
      },
    },
  ],
}

Updates and saves all of the information about a component, based on component ID.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#binding_propertiesHash<String,Types::ComponentBindingPropertiesValue>

The data binding information for the component's properties.

Returns:



6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 6540

class UpdateComponentData < Struct.new(
  :binding_properties,
  :children,
  :collection_properties,
  :component_type,
  :events,
  :id,
  :name,
  :overrides,
  :properties,
  :schema_version,
  :source_id,
  :variants)
  SENSITIVE = []
  include Aws::Structure
end

#childrenArray<Types::ComponentChild>

The components that are instances of the main component.

Returns:



6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 6540

class UpdateComponentData < Struct.new(
  :binding_properties,
  :children,
  :collection_properties,
  :component_type,
  :events,
  :id,
  :name,
  :overrides,
  :properties,
  :schema_version,
  :source_id,
  :variants)
  SENSITIVE = []
  include Aws::Structure
end

#collection_propertiesHash<String,Types::ComponentDataConfiguration>

The configuration for binding a component's properties to a data model. Use this for a collection component.

Returns:



6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 6540

class UpdateComponentData < Struct.new(
  :binding_properties,
  :children,
  :collection_properties,
  :component_type,
  :events,
  :id,
  :name,
  :overrides,
  :properties,
  :schema_version,
  :source_id,
  :variants)
  SENSITIVE = []
  include Aws::Structure
end

#component_typeString

The type of the component. This can be an Amplify custom UI component or another custom component.

Returns:

  • (String)


6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 6540

class UpdateComponentData < Struct.new(
  :binding_properties,
  :children,
  :collection_properties,
  :component_type,
  :events,
  :id,
  :name,
  :overrides,
  :properties,
  :schema_version,
  :source_id,
  :variants)
  SENSITIVE = []
  include Aws::Structure
end

#eventsHash<String,Types::ComponentEvent>

The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

Returns:



6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 6540

class UpdateComponentData < Struct.new(
  :binding_properties,
  :children,
  :collection_properties,
  :component_type,
  :events,
  :id,
  :name,
  :overrides,
  :properties,
  :schema_version,
  :source_id,
  :variants)
  SENSITIVE = []
  include Aws::Structure
end

#idString

The unique ID of the component to update.

Returns:

  • (String)


6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 6540

class UpdateComponentData < Struct.new(
  :binding_properties,
  :children,
  :collection_properties,
  :component_type,
  :events,
  :id,
  :name,
  :overrides,
  :properties,
  :schema_version,
  :source_id,
  :variants)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the component to update.

Returns:

  • (String)


6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 6540

class UpdateComponentData < Struct.new(
  :binding_properties,
  :children,
  :collection_properties,
  :component_type,
  :events,
  :id,
  :name,
  :overrides,
  :properties,
  :schema_version,
  :source_id,
  :variants)
  SENSITIVE = []
  include Aws::Structure
end

#overridesHash<String,Hash<String,String>>

Describes the properties that can be overriden to customize the component.

Returns:

  • (Hash<String,Hash<String,String>>)


6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 6540

class UpdateComponentData < Struct.new(
  :binding_properties,
  :children,
  :collection_properties,
  :component_type,
  :events,
  :id,
  :name,
  :overrides,
  :properties,
  :schema_version,
  :source_id,
  :variants)
  SENSITIVE = []
  include Aws::Structure
end

#propertiesHash<String,Types::ComponentProperty>

Describes the component's properties.

Returns:



6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 6540

class UpdateComponentData < Struct.new(
  :binding_properties,
  :children,
  :collection_properties,
  :component_type,
  :events,
  :id,
  :name,
  :overrides,
  :properties,
  :schema_version,
  :source_id,
  :variants)
  SENSITIVE = []
  include Aws::Structure
end

#schema_versionString

The schema version of the component when it was imported.

Returns:

  • (String)


6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 6540

class UpdateComponentData < Struct.new(
  :binding_properties,
  :children,
  :collection_properties,
  :component_type,
  :events,
  :id,
  :name,
  :overrides,
  :properties,
  :schema_version,
  :source_id,
  :variants)
  SENSITIVE = []
  include Aws::Structure
end

#source_idString

The unique ID of the component in its original source system, such as Figma.

Returns:

  • (String)


6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 6540

class UpdateComponentData < Struct.new(
  :binding_properties,
  :children,
  :collection_properties,
  :component_type,
  :events,
  :id,
  :name,
  :overrides,
  :properties,
  :schema_version,
  :source_id,
  :variants)
  SENSITIVE = []
  include Aws::Structure
end

#variantsArray<Types::ComponentVariant>

A list of the unique variants of the main component being updated.

Returns:



6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 6540

class UpdateComponentData < Struct.new(
  :binding_properties,
  :children,
  :collection_properties,
  :component_type,
  :events,
  :id,
  :name,
  :overrides,
  :properties,
  :schema_version,
  :source_id,
  :variants)
  SENSITIVE = []
  include Aws::Structure
end