Struct aws_sdk_amplifyuibuilder::types::ActionParameters

#[non_exhaustive]
pub struct ActionParameters {
    pub type: Option<ComponentProperty>,
    pub url: Option<ComponentProperty>,
    pub anchor: Option<ComponentProperty>,
    pub target: Option<ComponentProperty>,
    pub global: Option<ComponentProperty>,
    pub model: Option<String>,
    pub id: Option<ComponentProperty>,
    pub fields: Option<HashMap<String, ComponentProperty>>,
    pub state: Option<MutationActionSetStateParameter>,
}

Represents the event action configuration for an element of a Component or ComponentChild. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. ActionParameters defines the action that is performed when an event occurs on the 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.

type: Option<ComponentProperty>

The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.

url: Option<ComponentProperty>

The URL to the location to open. Specify this value for a navigation action.

anchor: Option<ComponentProperty>

The HTML anchor link to the location to open. Specify this value for a navigation action.

target: Option<ComponentProperty>

The element within the same component to modify when the action occurs.

global: Option<ComponentProperty>

Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

model: Option<String>

The name of the data model. Use when the action performs an operation on an Amplify DataStore model.

id: Option<ComponentProperty>

The unique ID of the component that the ActionParameters apply to.

fields: Option<HashMap<String, ComponentProperty>>

A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.

state: Option<MutationActionSetStateParameter>

A key-value pair that specifies the state property name and its initial value.

Implementations

impl ActionParameters

pub fn type(&self) -> Option<&ComponentProperty>

The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.

pub fn url(&self) -> Option<&ComponentProperty>

The URL to the location to open. Specify this value for a navigation action.

pub fn anchor(&self) -> Option<&ComponentProperty>

The HTML anchor link to the location to open. Specify this value for a navigation action.

pub fn target(&self) -> Option<&ComponentProperty>

The element within the same component to modify when the action occurs.

pub fn global(&self) -> Option<&ComponentProperty>

Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

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

The name of the data model. Use when the action performs an operation on an Amplify DataStore model.

pub fn id(&self) -> Option<&ComponentProperty>

The unique ID of the component that the ActionParameters apply to.

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

A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.

pub fn state(&self) -> Option<&MutationActionSetStateParameter>

A key-value pair that specifies the state property name and its initial value.

impl ActionParameters

pub fn builder() -> ActionParametersBuilder

Creates a new builder-style object to manufacture ActionParameters.

Trait Implementations

impl Clone for ActionParameters

fn clone(&self) -> ActionParameters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ActionParameters

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

Formats the value using the given formatter.

impl PartialEq for ActionParameters

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