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.

appId

The unique ID of the Amplify app associated with the component.

Type: String

Required: Yes

bindingProperties

The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties.

Type: String to ComponentBindingPropertiesValue object map

Required: Yes

componentType

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

createdAt

The time that the component was created.

Type: Timestamp

Required: Yes

environmentName

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

Type: String

Required: Yes

id

The unique ID of the component.

Type: String

Required: Yes

name

The name of the component.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

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.

Type: String to string to string map map

Required: Yes

properties

Describes the component's properties. You can't specify tags as a valid property for properties.

Type: String to ComponentProperty object map

Required: Yes

variants

A list of the component's variants. A variant is a unique style configuration of a main component.

Type: Array of ComponentVariant objects

Required: Yes

children

A list of the component's ComponentChild instances.

Type: Array of ComponentChild objects

Required: No

collectionProperties

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.

Type: String to ComponentDataConfiguration object map

Required: No

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.

Type: String to ComponentEvent object map

Required: No

modifiedAt

The time that the component was modified.

Type: Timestamp

Required: No

schemaVersion

The schema version of the component when it was imported.

Type: String

Required: No

sourceId

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

Type: String

Required: No

tags

One or more key-value pairs to use when tagging the component.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+

Value Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

Component

Contents

See Also