Struct aws_sdk_amplifyuibuilder::types::CreateComponentData

#[non_exhaustive]
pub struct CreateComponentData {
    pub name: String,
    pub source_id: Option<String>,
    pub component_type: String,
    pub properties: HashMap<String, ComponentProperty>,
    pub children: Option<Vec<ComponentChild>>,
    pub variants: Vec<ComponentVariant>,
    pub overrides: HashMap<String, HashMap<String, String>>,
    pub binding_properties: HashMap<String, ComponentBindingPropertiesValue>,
    pub collection_properties: Option<HashMap<String, ComponentDataConfiguration>>,
    pub tags: Option<HashMap<String, String>>,
    pub events: Option<HashMap<String, ComponentEvent>>,
    pub schema_version: Option<String>,
}

Represents all of the information that is required to create a component.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

The name of the component

source_id: Option<String>

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

component_type: String

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

properties: HashMap<String, ComponentProperty>

Describes the component's properties.

children: Option<Vec<ComponentChild>>

A list of child components that are instances of the main component.

variants: Vec<ComponentVariant>

A list of the unique variants of this component.

overrides: HashMap<String, HashMap<String, String>>

Describes the component properties that can be overriden to customize an instance of the component.

binding_properties: HashMap<String, ComponentBindingPropertiesValue>

The data binding information for the component's properties.

collection_properties: Option<HashMap<String, ComponentDataConfiguration>>

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

tags: Option<HashMap<String, String>>

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

events: Option<HashMap<String, 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.

schema_version: Option<String>

The schema version of the component when it was imported.

Implementations

impl CreateComponentData

pub fn name(&self) -> &str

The name of the component

pub fn source_id(&self) -> Option<&str>

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

pub fn component_type(&self) -> &str

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

pub fn properties(&self) -> &HashMap<String, ComponentProperty>

Describes the component's properties.

pub fn children(&self) -> &[ComponentChild]

A list of child components that are instances of the main component.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .children.is_none().

pub fn variants(&self) -> &[ComponentVariant]

A list of the unique variants of this component.

pub fn overrides(&self) -> &HashMap<String, HashMap<String, String>>

Describes the component properties that can be overriden to customize an instance of the component.

pub fn binding_properties( &self ) -> &HashMap<String, ComponentBindingPropertiesValue>

The data binding information for the component's properties.

pub fn collection_properties( &self ) -> Option<&HashMap<String, ComponentDataConfiguration>>

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

pub fn tags(&self) -> Option<&HashMap<String, String>>

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

pub fn events(&self) -> Option<&HashMap<String, 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.

pub fn schema_version(&self) -> Option<&str>

The schema version of the component when it was imported.

impl CreateComponentData

pub fn builder() -> CreateComponentDataBuilder

Creates a new builder-style object to manufacture CreateComponentData.

Trait Implementations

impl Clone for CreateComponentData

fn clone(&self) -> CreateComponentData

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateComponentData

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateComponentData

fn eq(&self, other: &CreateComponentData) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateComponentData