Class: Aws::AmplifyUIBuilder::Types::ActionParameters

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-amplifyuibuilder/types.rb

Overview

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#anchor ⇒ Types::ComponentProperty

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

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 66

class ActionParameters < Struct.new(
  :type,
  :url,
  :anchor,
  :target,
  :global,
  :model,
  :id,
  :fields,
  :state)
  SENSITIVE = []
  include Aws::Structure
end

#fields ⇒ Hash<String,Types::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.

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 66

class ActionParameters < Struct.new(
  :type,
  :url,
  :anchor,
  :target,
  :global,
  :model,
  :id,
  :fields,
  :state)
  SENSITIVE = []
  include Aws::Structure
end

#global ⇒ Types::ComponentProperty

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

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 66

class ActionParameters < Struct.new(
  :type,
  :url,
  :anchor,
  :target,
  :global,
  :model,
  :id,
  :fields,
  :state)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ Types::ComponentProperty

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

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 66

class ActionParameters < Struct.new(
  :type,
  :url,
  :anchor,
  :target,
  :global,
  :model,
  :id,
  :fields,
  :state)
  SENSITIVE = []
  include Aws::Structure
end

#model ⇒ String

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

Returns:

  • (String) 


66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 66

class ActionParameters < Struct.new(
  :type,
  :url,
  :anchor,
  :target,
  :global,
  :model,
  :id,
  :fields,
  :state)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ Types::MutationActionSetStateParameter

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

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 66

class ActionParameters < Struct.new(
  :type,
  :url,
  :anchor,
  :target,
  :global,
  :model,
  :id,
  :fields,
  :state)
  SENSITIVE = []
  include Aws::Structure
end

#target ⇒ Types::ComponentProperty

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

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 66

class ActionParameters < Struct.new(
  :type,
  :url,
  :anchor,
  :target,
  :global,
  :model,
  :id,
  :fields,
  :state)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ Types::ComponentProperty

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

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 66

class ActionParameters < Struct.new(
  :type,
  :url,
  :anchor,
  :target,
  :global,
  :model,
  :id,
  :fields,
  :state)
  SENSITIVE = []
  include Aws::Structure
end

#url ⇒ Types::ComponentProperty

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

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 66

class ActionParameters < Struct.new(
  :type,
  :url,
  :anchor,
  :target,
  :global,
  :model,
  :id,
  :fields,
  :state)
  SENSITIVE = []
  include Aws::Structure
end