ComponentArgs

data class ComponentArgs(val appId: Output<String>? = null, val bindingProperties: Output<Map<String, ComponentBindingPropertiesValueArgs>>? = null, val children: Output<List<ComponentChildArgs>>? = null, val collectionProperties: Output<Map<String, ComponentDataConfigurationArgs>>? = null, val componentType: Output<String>? = null, val environmentName: Output<String>? = null, val events: Output<Map<String, ComponentEventArgs>>? = null, val name: Output<String>? = null, val overrides: Output<Map<String, Any>>? = null, val properties: Output<Map<String, ComponentPropertyArgs>>? = null, val schemaVersion: Output<String>? = null, val sourceId: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val variants: Output<List<ComponentVariantArgs>>? = null) : ConvertibleToJava<ComponentArgs>

Definition of AWS::AmplifyUIBuilder::Component Resource Type

Constructors

Link copied to clipboard
constructor(appId: Output<String>? = null, bindingProperties: Output<Map<String, ComponentBindingPropertiesValueArgs>>? = null, children: Output<List<ComponentChildArgs>>? = null, collectionProperties: Output<Map<String, ComponentDataConfigurationArgs>>? = null, componentType: Output<String>? = null, environmentName: Output<String>? = null, events: Output<Map<String, ComponentEventArgs>>? = null, name: Output<String>? = null, overrides: Output<Map<String, Any>>? = null, properties: Output<Map<String, ComponentPropertyArgs>>? = null, schemaVersion: Output<String>? = null, sourceId: Output<String>? = null, tags: Output<Map<String, String>>? = null, variants: Output<List<ComponentVariantArgs>>? = null)

Properties

Link copied to clipboard
val appId: Output<String>? = null

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

Link copied to clipboard

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

Link copied to clipboard
val children: Output<List<ComponentChildArgs>>? = null

A list of the component's ComponentChild instances.

Link copied to clipboard

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 .

Link copied to clipboard
val componentType: Output<String>? = null

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

Link copied to clipboard
val environmentName: Output<String>? = null

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

Link copied to clipboard
val events: Output<Map<String, ComponentEventArgs>>? = null

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.

Link copied to clipboard
val name: Output<String>? = null

The name of the component.

Link copied to clipboard
val overrides: Output<Map<String, Any>>? = null

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 .

Link copied to clipboard

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

Link copied to clipboard
val schemaVersion: Output<String>? = null

The schema version of the component when it was imported.

Link copied to clipboard
val sourceId: Output<String>? = null

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

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

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

Link copied to clipboard
val variants: Output<List<ComponentVariantArgs>>? = null

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

Functions

Link copied to clipboard
open override fun toJava(): ComponentArgs