AWS::AmplifyUIBuilder::Component ComponentProperty

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "BindingProperties" : ComponentPropertyBindingProperties,
  "Bindings" : {Key: Value, ...},
  "CollectionBindingProperties" : ComponentPropertyBindingProperties,
  "ComponentName" : String,
  "Concat" : [ ComponentProperty, ... ],
  "Condition" : ComponentConditionProperty,
  "Configured" : Boolean,
  "DefaultValue" : String,
  "Event" : String,
  "ImportedValue" : String,
  "Model" : String,
  "Property" : String,
  "Type" : String,
  "UserAttribute" : String,
  "Value" : String
}

YAML

  BindingProperties: 
    ComponentPropertyBindingProperties
  Bindings: 
    Key: Value
  CollectionBindingProperties: 
    ComponentPropertyBindingProperties
  ComponentName: String
  Concat: 
    - ComponentProperty
  Condition: 
    ComponentConditionProperty
  Configured: Boolean
  DefaultValue: String
  Event: String
  ImportedValue: String
  Model: String
  Property: String
  Type: String
  UserAttribute: String
  Value: String

Properties

BindingProperties

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

Required: No

Type: ComponentPropertyBindingProperties

Update requires: No interruption

Bindings

The information to bind the component property to form data.

Required: No

Type: Object of FormBindingElement

Update requires: No interruption

CollectionBindingProperties

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

Required: No

Type: ComponentPropertyBindingProperties

Update requires: No interruption

ComponentName

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

Required: No

Type: String

Update requires: No interruption

Concat

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

Required: No

Type: Array of ComponentProperty

Update requires: No interruption

Condition

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

Required: No

Type: ComponentConditionProperty

Update requires: No interruption

Configured

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

Required: No

Type: Boolean

Update requires: No interruption

DefaultValue

The default value to assign to the component property.

Required: No

Type: String

Update requires: No interruption

Event

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

Required: No

Type: String

Update requires: No interruption

ImportedValue

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

Required: No

Type: String

Update requires: No interruption

Model

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

Required: No

Type: String

Update requires: No interruption

Property

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

Required: No

Type: String

Update requires: No interruption

Type

The component type.

Required: No

Type: String

Update requires: No interruption

UserAttribute

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

Required: No

Type: String

Update requires: No interruption

Value

The value to assign to the component property.

Required: No

Type: String

Update requires: No interruption