Struct aws_sdk_amplifyuibuilder::types::Component

#[non_exhaustive]
pub struct Component {

    pub app_id: String,
    pub environment_name: String,
    pub source_id: Option<String>,
    pub id: String,
    pub name: 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 created_at: DateTime,
    pub modified_at: Option<DateTime>,
    pub tags: Option<HashMap<String, String>>,
    pub events: Option<HashMap<String, ComponentEvent>>,
    pub schema_version: Option<String>,
}

Contains the configuration settings for a user interface (UI) element for an Amplify app. A component is configured as a primary, stand-alone UI element. Use ComponentChild to configure an instance of a Component. A ComponentChild instance inherits the configuration of the main 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.

app_id: String

The unique ID of the Amplify app associated with the component.

environment_name: String

The name of the backend environment that is a part of the Amplify app.

source_id: Option<String>

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

id: String

The unique ID of the component.

name: String

The name of the component.

component_type: String

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

properties: HashMap<String, ComponentProperty>

Describes the component's properties. You can't specify tags as a valid property for properties.

children: Option<Vec<ComponentChild>>

A list of the component's ComponentChild instances.

variants: Vec<ComponentVariant>

A list of the component's variants. A variant is a unique style configuration of a main component.

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

Describes the component's properties that can be overriden in a customized instance of the component. You can't specify tags as a valid property for overrides.

binding_properties: HashMap<String, ComponentBindingPropertiesValue>

The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties.

collection_properties: Option<HashMap<String, ComponentDataConfiguration>>

The data binding configuration for the component's properties. Use this for a collection component. You can't specify tags as a valid property for collectionProperties.

created_at: DateTime

The time that the component was created.

modified_at: Option<DateTime>

The time that the component was modified.

tags: Option<HashMap<String, String>>

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

events: Option<HashMap<String, ComponentEvent>>

Describes the events that can be raised on 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 Component

pub fn app_id(&self) -> &str

The unique ID of the Amplify app associated with the component.

pub fn environment_name(&self) -> &str

The name of the backend environment that is a part of the Amplify app.

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

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

pub fn id(&self) -> &str

The unique ID of the component.

pub fn name(&self) -> &str

The name of the component.

pub fn component_type(&self) -> &str

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

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

Describes the component's properties. You can't specify tags as a valid property for properties.

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

A list of the component's ComponentChild instances.

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 component's variants. A variant is a unique style configuration of a main component.

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

Describes the component's properties that can be overriden in a customized instance of the component. You can't specify tags as a valid property for overrides.

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

The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties.

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

The data binding configuration for the component's properties. Use this for a collection component. You can't specify tags as a valid property for collectionProperties.

pub fn created_at(&self) -> &DateTime

The time that the component was created.

pub fn modified_at(&self) -> Option<&DateTime>

The time that the component was modified.

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

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

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

Describes the events that can be raised on 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 Component

pub fn builder() -> ComponentBuilder

Creates a new builder-style object to manufacture Component.

Trait Implementations

impl Clone for Component

fn clone(&self) -> Component

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Component

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

Formats the value using the given formatter.

impl PartialEq for Component

fn eq(&self, other: &Component) -> 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 Component