AWS::AmplifyUIBuilder::Component ActionParameters - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

AWS::AmplifyUIBuilder::Component ActionParameters

The ActionParameters property specifies 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.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

Properties

Anchor

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

Required: No

Type: ComponentProperty

Update requires: No interruption

Fields

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.

Required: No

Type: ComponentProperties

Update requires: No interruption

Global

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

Required: No

Type: ComponentProperty

Update requires: No interruption

Id

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

Required: No

Type: ComponentProperty

Update requires: No interruption

Model

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

Required: No

Type: String

Update requires: No interruption

State

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

Required: No

Type: MutationActionSetStateParameter

Update requires: No interruption

Target

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

Required: No

Type: ComponentProperty

Update requires: No interruption

Type

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

Required: No

Type: ComponentProperty

Update requires: No interruption

Url

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

Required: No

Type: ComponentProperty

Update requires: No interruption