ComponentProperty - AmplifyUIBuilder

ComponentProperty

Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.

Contents

bindingProperties

The information to bind the component property to data at runtime.

Type: ComponentPropertyBindingProperties object

Required: No

bindings

The information to bind the component property to form data.

Type: String to FormBindingElement object map

Required: No

collectionBindingProperties

The information to bind the component property to data at runtime. Use this for collection components.

Type: ComponentPropertyBindingProperties object

Required: No

componentName

The name of the component that is affected by an event.

Type: String

Required: No

concat

A list of component properties to concatenate to create the value to assign to this component property.

Type: Array of ComponentProperty objects

Required: No

condition

The conditional expression to use to assign a value to the component property.

Type: ComponentConditionProperty object

Required: No

configured

Specifies whether the user configured the property in Amplify Studio after importing it.

Type: Boolean

Required: No

defaultValue

The default value to assign to the component property.

Type: String

Required: No

event

An event that occurs in your app. Use this for workflow data binding.

Type: String

Required: No

importedValue

The default value assigned to the property when the component is imported into an app.

Type: String

Required: No

model

The data model to use to assign a value to the component property.

Type: String

Required: No

property

The name of the component's property that is affected by an event.

Type: String

Required: No

type

The component type.

Type: String

Required: No

userAttribute

An authenticated user attribute to use to assign a value to the component property.

Type: String

Required: No

value

The value to assign to the component property.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: