interface ActionParametersProperty

Language	Type name
.NET	`Amazon.CDK.AWS.AmplifyUIBuilder.CfnComponent.ActionParametersProperty`
Java	`software.amazon.awscdk.services.amplifyuibuilder.CfnComponent.ActionParametersProperty`
Python	`aws_cdk.aws_amplifyuibuilder.CfnComponent.ActionParametersProperty`
TypeScript	`@aws-cdk/aws-amplifyuibuilder` » `CfnComponent` » `ActionParametersProperty`

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.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as amplifyuibuilder from '@aws-cdk/aws-amplifyuibuilder';

declare const componentPropertyProperty_: amplifyuibuilder.CfnComponent.ComponentPropertyProperty;
const actionParametersProperty: amplifyuibuilder.CfnComponent.ActionParametersProperty = {
  anchor: {
    bindingProperties: {
      property: 'property',

      // the properties below are optional
      field: 'field',
    },
    bindings: {
      bindingsKey: {
        element: 'element',
        property: 'property',
      },
    },
    collectionBindingProperties: {
      property: 'property',

      // the properties below are optional
      field: 'field',
    },
    componentName: 'componentName',
    concat: [componentPropertyProperty_],
    condition: {
      else: componentPropertyProperty_,
      field: 'field',
      operand: 'operand',
      operandType: 'operandType',
      operator: 'operator',
      property: 'property',
      then: componentPropertyProperty_,
    },
    configured: false,
    defaultValue: 'defaultValue',
    event: 'event',
    importedValue: 'importedValue',
    model: 'model',
    property: 'property',
    type: 'type',
    userAttribute: 'userAttribute',
    value: 'value',
  },
  fields: {
    fieldsKey: {
      bindingProperties: {
        property: 'property',

        // the properties below are optional
        field: 'field',
      },
      bindings: {
        bindingsKey: {
          element: 'element',
          property: 'property',
        },
      },
      collectionBindingProperties: {
        property: 'property',

        // the properties below are optional
        field: 'field',
      },
      componentName: 'componentName',
      concat: [componentPropertyProperty_],
      condition: {
        else: componentPropertyProperty_,
        field: 'field',
        operand: 'operand',
        operandType: 'operandType',
        operator: 'operator',
        property: 'property',
        then: componentPropertyProperty_,
      },
      configured: false,
      defaultValue: 'defaultValue',
      event: 'event',
      importedValue: 'importedValue',
      model: 'model',
      property: 'property',
      type: 'type',
      userAttribute: 'userAttribute',
      value: 'value',
    },
  },
  global: {
    bindingProperties: {
      property: 'property',

      // the properties below are optional
      field: 'field',
    },
    bindings: {
      bindingsKey: {
        element: 'element',
        property: 'property',
      },
    },
    collectionBindingProperties: {
      property: 'property',

      // the properties below are optional
      field: 'field',
    },
    componentName: 'componentName',
    concat: [componentPropertyProperty_],
    condition: {
      else: componentPropertyProperty_,
      field: 'field',
      operand: 'operand',
      operandType: 'operandType',
      operator: 'operator',
      property: 'property',
      then: componentPropertyProperty_,
    },
    configured: false,
    defaultValue: 'defaultValue',
    event: 'event',
    importedValue: 'importedValue',
    model: 'model',
    property: 'property',
    type: 'type',
    userAttribute: 'userAttribute',
    value: 'value',
  },
  id: {
    bindingProperties: {
      property: 'property',

      // the properties below are optional
      field: 'field',
    },
    bindings: {
      bindingsKey: {
        element: 'element',
        property: 'property',
      },
    },
    collectionBindingProperties: {
      property: 'property',

      // the properties below are optional
      field: 'field',
    },
    componentName: 'componentName',
    concat: [componentPropertyProperty_],
    condition: {
      else: componentPropertyProperty_,
      field: 'field',
      operand: 'operand',
      operandType: 'operandType',
      operator: 'operator',
      property: 'property',
      then: componentPropertyProperty_,
    },
    configured: false,
    defaultValue: 'defaultValue',
    event: 'event',
    importedValue: 'importedValue',
    model: 'model',
    property: 'property',
    type: 'type',
    userAttribute: 'userAttribute',
    value: 'value',
  },
  model: 'model',
  state: {
    componentName: 'componentName',
    property: 'property',
    set: {
      bindingProperties: {
        property: 'property',

        // the properties below are optional
        field: 'field',
      },
      bindings: {
        bindingsKey: {
          element: 'element',
          property: 'property',
        },
      },
      collectionBindingProperties: {
        property: 'property',

        // the properties below are optional
        field: 'field',
      },
      componentName: 'componentName',
      concat: [componentPropertyProperty_],
      condition: {
        else: componentPropertyProperty_,
        field: 'field',
        operand: 'operand',
        operandType: 'operandType',
        operator: 'operator',
        property: 'property',
        then: componentPropertyProperty_,
      },
      configured: false,
      defaultValue: 'defaultValue',
      event: 'event',
      importedValue: 'importedValue',
      model: 'model',
      property: 'property',
      type: 'type',
      userAttribute: 'userAttribute',
      value: 'value',
    },
  },
  target: {
    bindingProperties: {
      property: 'property',

      // the properties below are optional
      field: 'field',
    },
    bindings: {
      bindingsKey: {
        element: 'element',
        property: 'property',
      },
    },
    collectionBindingProperties: {
      property: 'property',

      // the properties below are optional
      field: 'field',
    },
    componentName: 'componentName',
    concat: [componentPropertyProperty_],
    condition: {
      else: componentPropertyProperty_,
      field: 'field',
      operand: 'operand',
      operandType: 'operandType',
      operator: 'operator',
      property: 'property',
      then: componentPropertyProperty_,
    },
    configured: false,
    defaultValue: 'defaultValue',
    event: 'event',
    importedValue: 'importedValue',
    model: 'model',
    property: 'property',
    type: 'type',
    userAttribute: 'userAttribute',
    value: 'value',
  },
  type: {
    bindingProperties: {
      property: 'property',

      // the properties below are optional
      field: 'field',
    },
    bindings: {
      bindingsKey: {
        element: 'element',
        property: 'property',
      },
    },
    collectionBindingProperties: {
      property: 'property',

      // the properties below are optional
      field: 'field',
    },
    componentName: 'componentName',
    concat: [componentPropertyProperty_],
    condition: {
      else: componentPropertyProperty_,
      field: 'field',
      operand: 'operand',
      operandType: 'operandType',
      operator: 'operator',
      property: 'property',
      then: componentPropertyProperty_,
    },
    configured: false,
    defaultValue: 'defaultValue',
    event: 'event',
    importedValue: 'importedValue',
    model: 'model',
    property: 'property',
    type: 'type',
    userAttribute: 'userAttribute',
    value: 'value',
  },
  url: {
    bindingProperties: {
      property: 'property',

      // the properties below are optional
      field: 'field',
    },
    bindings: {
      bindingsKey: {
        element: 'element',
        property: 'property',
      },
    },
    collectionBindingProperties: {
      property: 'property',

      // the properties below are optional
      field: 'field',
    },
    componentName: 'componentName',
    concat: [componentPropertyProperty_],
    condition: {
      else: componentPropertyProperty_,
      field: 'field',
      operand: 'operand',
      operandType: 'operandType',
      operator: 'operator',
      property: 'property',
      then: componentPropertyProperty_,
    },
    configured: false,
    defaultValue: 'defaultValue',
    event: 'event',
    importedValue: 'importedValue',
    model: 'model',
    property: 'property',
    type: 'type',
    userAttribute: 'userAttribute',
    value: 'value',
  },
};

Properties

Name	Type	Description
anchor?	`IResolvable` `\|` `ComponentPropertyProperty`	The HTML anchor link to the location to open.
fields?	`IResolvable` `\| { [string]:` `IResolvable` `\|` `ComponentPropertyProperty` `}`	A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model.
global?	`IResolvable` `\|` `ComponentPropertyProperty`	Specifies whether the user should be signed out globally.
id?	`IResolvable` `\|` `ComponentPropertyProperty`	The unique ID of the component that the `ActionParameters` apply to.
model?	`string`	The name of the data model.
state?	`IResolvable` `\|` `MutationActionSetStateParameterProperty`	A key-value pair that specifies the state property name and its initial value.
target?	`IResolvable` `\|` `ComponentPropertyProperty`	The element within the same component to modify when the action occurs.
type?	`IResolvable` `\|` `ComponentPropertyProperty`	The type of navigation action.
url?	`IResolvable` `\|` `ComponentPropertyProperty`	The URL to the location to open.