Interface CfnComponent.ActionParametersProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnComponent.ActionParametersProperty.Jsii$Proxy
- Enclosing class:
CfnComponent
@Stability(Stable)
public static interface CfnComponent.ActionParametersProperty
extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.services.amplifyuibuilder.*; ComponentPropertyProperty componentPropertyProperty_; ActionParametersProperty actionParametersProperty = ActionParametersProperty.builder() .anchor(ComponentPropertyProperty.builder() .bindingProperties(ComponentPropertyBindingPropertiesProperty.builder() .property("property") // the properties below are optional .field("field") .build()) .bindings(Map.of( "bindingsKey", FormBindingElementProperty.builder() .element("element") .property("property") .build())) .collectionBindingProperties(ComponentPropertyBindingPropertiesProperty.builder() .property("property") // the properties below are optional .field("field") .build()) .componentName("componentName") .concat(List.of(componentPropertyProperty_)) .condition(ComponentConditionPropertyProperty.builder() .else(componentPropertyProperty_) .field("field") .operand("operand") .operandType("operandType") .operator("operator") .property("property") .then(componentPropertyProperty_) .build()) .configured(false) .defaultValue("defaultValue") .event("event") .importedValue("importedValue") .model("model") .property("property") .type("type") .userAttribute("userAttribute") .value("value") .build()) .fields(Map.of( "fieldsKey", ComponentPropertyProperty.builder() .bindingProperties(ComponentPropertyBindingPropertiesProperty.builder() .property("property") // the properties below are optional .field("field") .build()) .bindings(Map.of( "bindingsKey", FormBindingElementProperty.builder() .element("element") .property("property") .build())) .collectionBindingProperties(ComponentPropertyBindingPropertiesProperty.builder() .property("property") // the properties below are optional .field("field") .build()) .componentName("componentName") .concat(List.of(componentPropertyProperty_)) .condition(ComponentConditionPropertyProperty.builder() .else(componentPropertyProperty_) .field("field") .operand("operand") .operandType("operandType") .operator("operator") .property("property") .then(componentPropertyProperty_) .build()) .configured(false) .defaultValue("defaultValue") .event("event") .importedValue("importedValue") .model("model") .property("property") .type("type") .userAttribute("userAttribute") .value("value") .build())) .global(ComponentPropertyProperty.builder() .bindingProperties(ComponentPropertyBindingPropertiesProperty.builder() .property("property") // the properties below are optional .field("field") .build()) .bindings(Map.of( "bindingsKey", FormBindingElementProperty.builder() .element("element") .property("property") .build())) .collectionBindingProperties(ComponentPropertyBindingPropertiesProperty.builder() .property("property") // the properties below are optional .field("field") .build()) .componentName("componentName") .concat(List.of(componentPropertyProperty_)) .condition(ComponentConditionPropertyProperty.builder() .else(componentPropertyProperty_) .field("field") .operand("operand") .operandType("operandType") .operator("operator") .property("property") .then(componentPropertyProperty_) .build()) .configured(false) .defaultValue("defaultValue") .event("event") .importedValue("importedValue") .model("model") .property("property") .type("type") .userAttribute("userAttribute") .value("value") .build()) .id(ComponentPropertyProperty.builder() .bindingProperties(ComponentPropertyBindingPropertiesProperty.builder() .property("property") // the properties below are optional .field("field") .build()) .bindings(Map.of( "bindingsKey", FormBindingElementProperty.builder() .element("element") .property("property") .build())) .collectionBindingProperties(ComponentPropertyBindingPropertiesProperty.builder() .property("property") // the properties below are optional .field("field") .build()) .componentName("componentName") .concat(List.of(componentPropertyProperty_)) .condition(ComponentConditionPropertyProperty.builder() .else(componentPropertyProperty_) .field("field") .operand("operand") .operandType("operandType") .operator("operator") .property("property") .then(componentPropertyProperty_) .build()) .configured(false) .defaultValue("defaultValue") .event("event") .importedValue("importedValue") .model("model") .property("property") .type("type") .userAttribute("userAttribute") .value("value") .build()) .model("model") .state(MutationActionSetStateParameterProperty.builder() .componentName("componentName") .property("property") .set(ComponentPropertyProperty.builder() .bindingProperties(ComponentPropertyBindingPropertiesProperty.builder() .property("property") // the properties below are optional .field("field") .build()) .bindings(Map.of( "bindingsKey", FormBindingElementProperty.builder() .element("element") .property("property") .build())) .collectionBindingProperties(ComponentPropertyBindingPropertiesProperty.builder() .property("property") // the properties below are optional .field("field") .build()) .componentName("componentName") .concat(List.of(componentPropertyProperty_)) .condition(ComponentConditionPropertyProperty.builder() .else(componentPropertyProperty_) .field("field") .operand("operand") .operandType("operandType") .operator("operator") .property("property") .then(componentPropertyProperty_) .build()) .configured(false) .defaultValue("defaultValue") .event("event") .importedValue("importedValue") .model("model") .property("property") .type("type") .userAttribute("userAttribute") .value("value") .build()) .build()) .target(ComponentPropertyProperty.builder() .bindingProperties(ComponentPropertyBindingPropertiesProperty.builder() .property("property") // the properties below are optional .field("field") .build()) .bindings(Map.of( "bindingsKey", FormBindingElementProperty.builder() .element("element") .property("property") .build())) .collectionBindingProperties(ComponentPropertyBindingPropertiesProperty.builder() .property("property") // the properties below are optional .field("field") .build()) .componentName("componentName") .concat(List.of(componentPropertyProperty_)) .condition(ComponentConditionPropertyProperty.builder() .else(componentPropertyProperty_) .field("field") .operand("operand") .operandType("operandType") .operator("operator") .property("property") .then(componentPropertyProperty_) .build()) .configured(false) .defaultValue("defaultValue") .event("event") .importedValue("importedValue") .model("model") .property("property") .type("type") .userAttribute("userAttribute") .value("value") .build()) .type(ComponentPropertyProperty.builder() .bindingProperties(ComponentPropertyBindingPropertiesProperty.builder() .property("property") // the properties below are optional .field("field") .build()) .bindings(Map.of( "bindingsKey", FormBindingElementProperty.builder() .element("element") .property("property") .build())) .collectionBindingProperties(ComponentPropertyBindingPropertiesProperty.builder() .property("property") // the properties below are optional .field("field") .build()) .componentName("componentName") .concat(List.of(componentPropertyProperty_)) .condition(ComponentConditionPropertyProperty.builder() .else(componentPropertyProperty_) .field("field") .operand("operand") .operandType("operandType") .operator("operator") .property("property") .then(componentPropertyProperty_) .build()) .configured(false) .defaultValue("defaultValue") .event("event") .importedValue("importedValue") .model("model") .property("property") .type("type") .userAttribute("userAttribute") .value("value") .build()) .url(ComponentPropertyProperty.builder() .bindingProperties(ComponentPropertyBindingPropertiesProperty.builder() .property("property") // the properties below are optional .field("field") .build()) .bindings(Map.of( "bindingsKey", FormBindingElementProperty.builder() .element("element") .property("property") .build())) .collectionBindingProperties(ComponentPropertyBindingPropertiesProperty.builder() .property("property") // the properties below are optional .field("field") .build()) .componentName("componentName") .concat(List.of(componentPropertyProperty_)) .condition(ComponentConditionPropertyProperty.builder() .else(componentPropertyProperty_) .field("field") .operand("operand") .operandType("operandType") .operator("operator") .property("property") .then(componentPropertyProperty_) .build()) .configured(false) .defaultValue("defaultValue") .event("event") .importedValue("importedValue") .model("model") .property("property") .type("type") .userAttribute("userAttribute") .value("value") .build()) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnComponent.ActionParametersProperty
static final class
An implementation forCfnComponent.ActionParametersProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
The HTML anchor link to the location to open.default Object
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model.default Object
Specifies whether the user should be signed out globally.default Object
getId()
The unique ID of the component that theActionParameters
apply to.default String
getModel()
The name of the data model.default Object
getState()
A key-value pair that specifies the state property name and its initial value.default Object
The element within the same component to modify when the action occurs.default Object
getType()
The type of navigation action.default Object
getUrl()
The URL to the location to open.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAnchor
The HTML anchor link to the location to open.Specify this value for a navigation action.
-
getFields
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.
-
getGlobal
Specifies whether the user should be signed out globally.Specify this value for an auth sign out action.
-
getId
The unique ID of the component that theActionParameters
apply to. -
getModel
The name of the data model.Use when the action performs an operation on an Amplify DataStore model.
-
getState
A key-value pair that specifies the state property name and its initial value. -
getTarget
The element within the same component to modify when the action occurs. -
getType
The type of navigation action.Valid values are
url
andanchor
. This value is required for a navigation action. -
getUrl
The URL to the location to open.Specify this value for a navigation action.
-
builder
-