Amazonka.AmplifyUiBuilder.Types.ComponentProperty

Documentation

data ComponentProperty

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

See: newComponentProperty smart constructor.

Constructors

ComponentProperty'

Fields

• bindingProperties :: Maybe ComponentPropertyBindingProperties

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

• bindings :: Maybe (HashMap Text FormBindingElement)

  The information to bind the component property to form data.

• collectionBindingProperties :: Maybe ComponentPropertyBindingProperties

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

• componentName :: Maybe Text

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

• concat :: Maybe [ComponentProperty]

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

• condition :: Maybe ComponentConditionProperty

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

• configured :: Maybe Bool

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

• defaultValue :: Maybe Text

  The default value to assign to the component property.

• event :: Maybe Text

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

• importedValue :: Maybe Text

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

• model :: Maybe Text

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

• property :: Maybe Text

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

• type' :: Maybe Text

  The component type.

• userAttribute :: Maybe Text

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

• value :: Maybe Text

  The value to assign to the component property.

Instances

FromJSON ComponentProperty

Defined in Amazonka.AmplifyUiBuilder.Types.ComponentProperty

Methods

parseJSON :: Value -> Parser ComponentProperty

parseJSONList :: Value -> Parser [ComponentProperty]

ToJSON ComponentProperty

Defined in Amazonka.AmplifyUiBuilder.Types.ComponentProperty

Methods

toJSON :: ComponentProperty -> Value

toEncoding :: ComponentProperty -> Encoding

toJSONList :: [ComponentProperty] -> Value

toEncodingList :: [ComponentProperty] -> Encoding

Generic ComponentProperty

Defined in Amazonka.AmplifyUiBuilder.Types.ComponentProperty

Associated Types

type Rep ComponentProperty :: Type -> Type

Methods

from :: ComponentProperty -> Rep ComponentProperty x

to :: Rep ComponentProperty x -> ComponentProperty

Read ComponentProperty

Defined in Amazonka.AmplifyUiBuilder.Types.ComponentProperty

Methods

readsPrec :: Int -> ReadS ComponentProperty

readList :: ReadS [ComponentProperty]

readPrec :: ReadPrec ComponentProperty

readListPrec :: ReadPrec [ComponentProperty]

Show ComponentProperty

Defined in Amazonka.AmplifyUiBuilder.Types.ComponentProperty

Methods

showsPrec :: Int -> ComponentProperty -> ShowS

show :: ComponentProperty -> String

showList :: [ComponentProperty] -> ShowS

NFData ComponentProperty

Defined in Amazonka.AmplifyUiBuilder.Types.ComponentProperty

Methods

rnf :: ComponentProperty -> ()

Eq ComponentProperty

Defined in Amazonka.AmplifyUiBuilder.Types.ComponentProperty

Methods

(==) :: ComponentProperty -> ComponentProperty -> Bool

(/=) :: ComponentProperty -> ComponentProperty -> Bool

Hashable ComponentProperty

Defined in Amazonka.AmplifyUiBuilder.Types.ComponentProperty

Methods

hashWithSalt :: Int -> ComponentProperty -> Int

hash :: ComponentProperty -> Int

type Rep ComponentProperty

Defined in Amazonka.AmplifyUiBuilder.Types.ComponentProperty

type Rep ComponentProperty = D1 ('MetaData "ComponentProperty" "Amazonka.AmplifyUiBuilder.Types.ComponentProperty" "amazonka-amplifyuibuilder-2.0-KN0MRaPu7dZCAXr3ruBTcC" 'False) (C1 ('MetaCons "ComponentProperty'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bindingProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComponentPropertyBindingProperties)) :*: (S1 ('MetaSel ('Just "bindings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text FormBindingElement))) :*: S1 ('MetaSel ('Just "collectionBindingProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComponentPropertyBindingProperties)))) :*: ((S1 ('MetaSel ('Just "componentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "concat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ComponentProperty]))) :*: (S1 ('MetaSel ('Just "condition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComponentConditionProperty)) :*: S1 ('MetaSel ('Just "configured") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: (((S1 ('MetaSel ('Just "defaultValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "event") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "importedValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "property") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "userAttribute") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newComponentProperty :: ComponentProperty

Create a value of ComponentProperty with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:bindingProperties:ComponentProperty', componentProperty_bindingProperties - The information to bind the component property to data at runtime.

$sel:bindings:ComponentProperty', componentProperty_bindings - The information to bind the component property to form data.

$sel:collectionBindingProperties:ComponentProperty', componentProperty_collectionBindingProperties - The information to bind the component property to data at runtime. Use this for collection components.

$sel:componentName:ComponentProperty', componentProperty_componentName - The name of the component that is affected by an event.

$sel:concat:ComponentProperty', componentProperty_concat - A list of component properties to concatenate to create the value to assign to this component property.

$sel:condition:ComponentProperty', componentProperty_condition - The conditional expression to use to assign a value to the component property.

$sel:configured:ComponentProperty', componentProperty_configured - Specifies whether the user configured the property in Amplify Studio after importing it.

$sel:defaultValue:ComponentProperty', componentProperty_defaultValue - The default value to assign to the component property.

$sel:event:ComponentProperty', componentProperty_event - An event that occurs in your app. Use this for workflow data binding.

$sel:importedValue:ComponentProperty', componentProperty_importedValue - The default value assigned to the property when the component is imported into an app.

$sel:model:ComponentProperty', componentProperty_model - The data model to use to assign a value to the component property.

FormBindingElement, componentProperty_property - The name of the component's property that is affected by an event.

$sel:type':ComponentProperty', componentProperty_type - The component type.

$sel:userAttribute:ComponentProperty', componentProperty_userAttribute - An authenticated user attribute to use to assign a value to the component property.

$sel:value:ComponentProperty', componentProperty_value - The value to assign to the component property.

componentProperty_bindingProperties :: Lens' ComponentProperty (Maybe ComponentPropertyBindingProperties)

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

componentProperty_bindings :: Lens' ComponentProperty (Maybe (HashMap Text FormBindingElement))

The information to bind the component property to form data.

componentProperty_collectionBindingProperties :: Lens' ComponentProperty (Maybe ComponentPropertyBindingProperties)

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

componentProperty_componentName :: Lens' ComponentProperty (Maybe Text)

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

componentProperty_concat :: Lens' ComponentProperty (Maybe [ComponentProperty])

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

componentProperty_condition :: Lens' ComponentProperty (Maybe ComponentConditionProperty)

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

componentProperty_configured :: Lens' ComponentProperty (Maybe Bool)

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

componentProperty_defaultValue :: Lens' ComponentProperty (Maybe Text)

The default value to assign to the component property.

componentProperty_event :: Lens' ComponentProperty (Maybe Text)

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

componentProperty_importedValue :: Lens' ComponentProperty (Maybe Text)

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

componentProperty_model :: Lens' ComponentProperty (Maybe Text)

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

componentProperty_property :: Lens' ComponentProperty (Maybe Text)

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

componentProperty_type :: Lens' ComponentProperty (Maybe Text)

The component type.

componentProperty_userAttribute :: Lens' ComponentProperty (Maybe Text)

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

componentProperty_value :: Lens' ComponentProperty (Maybe Text)

The value to assign to the component property.