Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AmplifyUiBuilder.Types.UpdateComponentData

Description

Synopsis

data UpdateComponentData = UpdateComponentData' {
- bindingProperties :: Maybe (HashMap Text ComponentBindingPropertiesValue)
- children :: Maybe [ComponentChild]
- collectionProperties :: Maybe (HashMap Text ComponentDataConfiguration)
- componentType :: Maybe Text
- events :: Maybe (HashMap Text ComponentEvent)
- id :: Maybe Text
- name :: Maybe Text
- overrides :: Maybe (HashMap Text (HashMap Text Text))
- properties :: Maybe (HashMap Text ComponentProperty)
- schemaVersion :: Maybe Text
- sourceId :: Maybe Text
- variants :: Maybe [ComponentVariant]
}
newUpdateComponentData :: UpdateComponentData
updateComponentData_bindingProperties :: Lens' UpdateComponentData (Maybe (HashMap Text ComponentBindingPropertiesValue))
updateComponentData_children :: Lens' UpdateComponentData (Maybe [ComponentChild])
updateComponentData_collectionProperties :: Lens' UpdateComponentData (Maybe (HashMap Text ComponentDataConfiguration))
updateComponentData_componentType :: Lens' UpdateComponentData (Maybe Text)
updateComponentData_events :: Lens' UpdateComponentData (Maybe (HashMap Text ComponentEvent))
updateComponentData_id :: Lens' UpdateComponentData (Maybe Text)
updateComponentData_name :: Lens' UpdateComponentData (Maybe Text)
updateComponentData_overrides :: Lens' UpdateComponentData (Maybe (HashMap Text (HashMap Text Text)))
updateComponentData_properties :: Lens' UpdateComponentData (Maybe (HashMap Text ComponentProperty))
updateComponentData_schemaVersion :: Lens' UpdateComponentData (Maybe Text)
updateComponentData_sourceId :: Lens' UpdateComponentData (Maybe Text)
updateComponentData_variants :: Lens' UpdateComponentData (Maybe [ComponentVariant])

Documentation

data UpdateComponentData Source #

Updates and saves all of the information about a component, based on component ID.

See: newUpdateComponentData smart constructor.

Constructors

UpdateComponentData'

Fields

bindingProperties :: Maybe (HashMap Text ComponentBindingPropertiesValue)
The data binding information for the component's properties.
children :: Maybe [ComponentChild]
The components that are instances of the main component.
collectionProperties :: Maybe (HashMap Text ComponentDataConfiguration)
The configuration for binding a component's properties to a data model. Use this for a collection component.
componentType :: Maybe Text
The type of the component. This can be an Amplify custom UI component or another custom component.
events :: Maybe (HashMap Text ComponentEvent)
The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
id :: Maybe Text
The unique ID of the component to update.
name :: Maybe Text
The name of the component to update.
overrides :: Maybe (HashMap Text (HashMap Text Text))
Describes the properties that can be overriden to customize the component.
properties :: Maybe (HashMap Text ComponentProperty)
Describes the component's properties.
schemaVersion :: Maybe Text
The schema version of the component when it was imported.
sourceId :: Maybe Text
The unique ID of the component in its original source system, such as Figma.
variants :: Maybe [ComponentVariant]
A list of the unique variants of the main component being updated.

Instances

Instances details

ToJSON UpdateComponentData Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.UpdateComponentData Methods toJSON :: UpdateComponentData -> Value # toEncoding :: UpdateComponentData -> Encoding # toJSONList :: [UpdateComponentData] -> Value # toEncodingList :: [UpdateComponentData] -> Encoding #
Generic UpdateComponentData Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.UpdateComponentData Associated Types type Rep UpdateComponentData :: Type -> Type # Methods from :: UpdateComponentData -> Rep UpdateComponentData x # to :: Rep UpdateComponentData x -> UpdateComponentData #
Read UpdateComponentData Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.UpdateComponentData Methods readsPrec :: Int -> ReadS UpdateComponentData # readList :: ReadS [UpdateComponentData] # readPrec :: ReadPrec UpdateComponentData # readListPrec :: ReadPrec [UpdateComponentData] #
Show UpdateComponentData Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.UpdateComponentData Methods showsPrec :: Int -> UpdateComponentData -> ShowS # show :: UpdateComponentData -> String # showList :: [UpdateComponentData] -> ShowS #
NFData UpdateComponentData Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.UpdateComponentData Methods rnf :: UpdateComponentData -> () #
Eq UpdateComponentData Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.UpdateComponentData Methods (==) :: UpdateComponentData -> UpdateComponentData -> Bool # (/=) :: UpdateComponentData -> UpdateComponentData -> Bool #
Hashable UpdateComponentData Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.UpdateComponentData Methods hashWithSalt :: Int -> UpdateComponentData -> Int # hash :: UpdateComponentData -> Int #
type Rep UpdateComponentData Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.UpdateComponentData type Rep UpdateComponentData = D1 ('MetaData "UpdateComponentData" "Amazonka.AmplifyUiBuilder.Types.UpdateComponentData" "amazonka-amplifyuibuilder-2.0-KN0MRaPu7dZCAXr3ruBTcC" 'False) (C1 ('MetaCons "UpdateComponentData'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bindingProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text ComponentBindingPropertiesValue))) :: (S1 ('MetaSel ('Just "children") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ComponentChild])) :: S1 ('MetaSel ('Just "collectionProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text ComponentDataConfiguration))))) :: (S1 ('MetaSel ('Just "componentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "events") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text ComponentEvent))) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "overrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text (HashMap Text Text)))) :: S1 ('MetaSel ('Just "properties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text ComponentProperty))))) :: (S1 ('MetaSel ('Just "schemaVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "sourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "variants") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ComponentVariant])))))))

newUpdateComponentData :: UpdateComponentData Source #

Create a value of UpdateComponentData 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:

UpdateComponentData, updateComponentData_bindingProperties - The data binding information for the component's properties.

UpdateComponentData, updateComponentData_children - The components that are instances of the main component.

$sel:collectionProperties:UpdateComponentData', updateComponentData_collectionProperties - The configuration for binding a component's properties to a data model. Use this for a collection component.

UpdateComponentData, updateComponentData_componentType - The type of the component. This can be an Amplify custom UI component or another custom component.

UpdateComponentData, updateComponentData_events - The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

$sel:id:UpdateComponentData', updateComponentData_id - The unique ID of the component to update.

UpdateComponentData, updateComponentData_name - The name of the component to update.

UpdateComponentData, updateComponentData_overrides - Describes the properties that can be overriden to customize the component.

UpdateComponentData, updateComponentData_properties - Describes the component's properties.

$sel:schemaVersion:UpdateComponentData', updateComponentData_schemaVersion - The schema version of the component when it was imported.

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

$sel:variants:UpdateComponentData', updateComponentData_variants - A list of the unique variants of the main component being updated.

updateComponentData_bindingProperties :: Lens' UpdateComponentData (Maybe (HashMap Text ComponentBindingPropertiesValue)) Source #

The data binding information for the component's properties.

updateComponentData_children :: Lens' UpdateComponentData (Maybe [ComponentChild]) Source #

The components that are instances of the main component.

updateComponentData_collectionProperties :: Lens' UpdateComponentData (Maybe (HashMap Text ComponentDataConfiguration)) Source #

The configuration for binding a component's properties to a data model. Use this for a collection component.

updateComponentData_componentType :: Lens' UpdateComponentData (Maybe Text) Source #

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

updateComponentData_events :: Lens' UpdateComponentData (Maybe (HashMap Text ComponentEvent)) Source #

The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

updateComponentData_id :: Lens' UpdateComponentData (Maybe Text) Source #

The unique ID of the component to update.

updateComponentData_name :: Lens' UpdateComponentData (Maybe Text) Source #

The name of the component to update.

updateComponentData_overrides :: Lens' UpdateComponentData (Maybe (HashMap Text (HashMap Text Text))) Source #

Describes the properties that can be overriden to customize the component.

updateComponentData_properties :: Lens' UpdateComponentData (Maybe (HashMap Text ComponentProperty)) Source #

Describes the component's properties.

updateComponentData_schemaVersion :: Lens' UpdateComponentData (Maybe Text) Source #

The schema version of the component when it was imported.

updateComponentData_sourceId :: Lens' UpdateComponentData (Maybe Text) Source #

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

updateComponentData_variants :: Lens' UpdateComponentData (Maybe [ComponentVariant]) Source #

A list of the unique variants of the main component being updated.