amplifyuibuilder/aws.sdk.kotlin.services.amplifyuibuilder.model/Component

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.

Types

Builder

class Builder

Companion

object Companion

Properties

appId

val appId: String

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

bindingProperties

val bindingProperties: Map<String, ComponentBindingPropertiesValue>

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

children

val children: List<ComponentChild>?

A list of the component's ComponentChild instances.

collectionProperties

val collectionProperties: Map<String, ComponentDataConfiguration>?

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.

componentType

val componentType: String

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

createdAt

val createdAt: Instant

The time that the component was created.

environmentName

val environmentName: String

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

events

val events: Map<String, ComponentEvent>?

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.

val id: String

The unique ID of the component.

modifiedAt

val modifiedAt: Instant?

The time that the component was modified.

name

val name: String

The name of the component.

overrides

val overrides: Map<String, Map<String, String>>

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.

properties

val properties: Map<String, ComponentProperty>

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

schemaVersion

val schemaVersion: String?

The schema version of the component when it was imported.

sourceId

val sourceId: String?

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