class Aws::AmplifyUIBuilder::Types::Component

Contains the configuration settings for a user interface (UI) element for an Amplify app. A component is configured as a primary, stand-alone UI element. Use ‘ComponentChild` to configure an instance of a `Component`. A `ComponentChild` instance inherits the configuration of the main `Component`.

@!attribute [rw] app_id

The unique ID of the Amplify app associated with the component.
@return [String]

@!attribute [rw] binding_properties

The information to connect a component's properties to data at
runtime. You can't specify `tags` as a valid property for
`bindingProperties`.
@return [Hash<String,Types::ComponentBindingPropertiesValue>]

@!attribute [rw] children

A list of the component's `ComponentChild` instances.
@return [Array<Types::ComponentChild>]

@!attribute [rw] collection_properties

The data binding configuration for the component's properties. Use
this for a collection component. You can't specify `tags` as a
valid property for `collectionProperties`.
@return [Hash<String,Types::ComponentDataConfiguration>]

@!attribute [rw] component_type

The type of the component. This can be an Amplify custom UI
component or another custom component.
@return [String]

@!attribute [rw] created_at

The time that the component was created.
@return [Time]

@!attribute [rw] environment_name

The name of the backend environment that is a part of the Amplify
app.
@return [String]

@!attribute [rw] events

Describes the events that can be raised on the component. Use for
the workflow feature in Amplify Studio that allows you to bind
events and actions to components.
@return [Hash<String,Types::ComponentEvent>]

@!attribute [rw] id

The unique ID of the component.
@return [String]

@!attribute [rw] modified_at

The time that the component was modified.
@return [Time]

@!attribute [rw] name

The name of the component.
@return [String]

@!attribute [rw] overrides

Describes the component's properties that can be overriden in a
customized instance of the component. You can't specify `tags` as a
valid property for `overrides`.
@return [Hash<String,Hash<String,String>>]

@!attribute [rw] properties

Describes the component's properties. You can't specify `tags` as
a valid property for `properties`.
@return [Hash<String,Types::ComponentProperty>]

@!attribute [rw] schema_version

The schema version of the component when it was imported.
@return [String]

@!attribute [rw] source_id

The unique ID of the component in its original source system, such
as Figma.
@return [String]

@!attribute [rw] tags

One or more key-value pairs to use when tagging the component.
@return [Hash<String,String>]

@!attribute [rw] variants

A list of the component's variants. A variant is a unique style
configuration of a main component.
@return [Array<Types::ComponentVariant>]

@see docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/Component AWS API Documentation

Constants

SENSITIVE