Class: Aws::AmplifyUIBuilder::Types::CreateComponentRequest

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

{
  app_id: "String", # required
  client_token: "String",
  component_to_create: { # required
    binding_properties: { # required
      "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", # 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: "ComponentName", # required
    overrides: { # required
      "String" => {
        "String" => "String",
      },
    },
    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",
      },
    },
    schema_version: "String",
    source_id: "String",
    tags: {
      "TagKey" => "TagValue",
    },
    variants: [ # required
      {
        overrides: {
          "String" => {
            "String" => "String",
          },
        },
        variant_values: {
          "String" => "String",
        },
      },
    ],
  },
  environment_name: "String", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#app_idString

The unique ID of the Amplify app to associate with the component.

Returns:

  • (String)


4465
4466
4467
4468
4469
4470
4471
4472
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 4465

class CreateComponentRequest < Struct.new(
  :app_id,
  :client_token,
  :component_to_create,
  :environment_name)
  SENSITIVE = []
  include Aws::Structure
end

#client_tokenString

The unique client token.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


4465
4466
4467
4468
4469
4470
4471
4472
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 4465

class CreateComponentRequest < Struct.new(
  :app_id,
  :client_token,
  :component_to_create,
  :environment_name)
  SENSITIVE = []
  include Aws::Structure
end

#component_to_createTypes::CreateComponentData

Represents the configuration of the component to create.



4465
4466
4467
4468
4469
4470
4471
4472
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 4465

class CreateComponentRequest < Struct.new(
  :app_id,
  :client_token,
  :component_to_create,
  :environment_name)
  SENSITIVE = []
  include Aws::Structure
end

#environment_nameString

The name of the backend environment that is a part of the Amplify app.

Returns:

  • (String)


4465
4466
4467
4468
4469
4470
4471
4472
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 4465

class CreateComponentRequest < Struct.new(
  :app_id,
  :client_token,
  :component_to_create,
  :environment_name)
  SENSITIVE = []
  include Aws::Structure
end