@Stability(value=Stable)
public static interface CfnComponent.ActionParametersProperty
extends software.amazon.jsii.JsiiSerializable
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.*;
Object bindings;
ComponentPropertyProperty componentPropertyProperty_;
Object fields;
ActionParametersProperty actionParametersProperty = ActionParametersProperty.builder()
.anchor(ComponentPropertyProperty.builder()
.bindingProperties(ComponentPropertyBindingPropertiesProperty.builder()
.property("property")
// the properties below are optional
.field("field")
.build())
.bindings(bindings)
.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(fields)
.global(ComponentPropertyProperty.builder()
.bindingProperties(ComponentPropertyBindingPropertiesProperty.builder()
.property("property")
// the properties below are optional
.field("field")
.build())
.bindings(bindings)
.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(bindings)
.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(bindings)
.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(bindings)
.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(bindings)
.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(bindings)
.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();
| Modifier and Type | Interface and Description |
|---|---|
static class |
CfnComponent.ActionParametersProperty.Builder
A builder for
CfnComponent.ActionParametersProperty |
static class |
CfnComponent.ActionParametersProperty.Jsii$Proxy
An implementation for
CfnComponent.ActionParametersProperty |
| Modifier and Type | Method and Description |
|---|---|
static CfnComponent.ActionParametersProperty.Builder |
builder() |
default Object |
getAnchor()
The HTML anchor link to the location to open.
|
default Object |
getFields()
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model.
|
default Object |
getGlobal()
Specifies whether the user should be signed out globally.
|
default Object |
getId()
The unique ID of the component that the `ActionParameters` 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 |
getTarget()
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.
|
@Stability(value=Stable) @Nullable default Object getAnchor()
Specify this value for a navigation action.
@Stability(value=Stable) @Nullable default Object getFields()
Use when the action performs an operation on an Amplify DataStore model.
@Stability(value=Stable) @Nullable default Object getGlobal()
Specify this value for an auth sign out action.
@Stability(value=Stable) @Nullable default Object getId()
@Stability(value=Stable) @Nullable default String getModel()
Use when the action performs an operation on an Amplify DataStore model.
@Stability(value=Stable) @Nullable default Object getState()
@Stability(value=Stable) @Nullable default Object getTarget()
@Stability(value=Stable) @Nullable default Object getType()
Valid values are url and anchor . This value is required for a navigation action.
@Stability(value=Stable) @Nullable default Object getUrl()
Specify this value for a navigation action.
@Stability(value=Stable) static CfnComponent.ActionParametersProperty.Builder builder()
Copyright © 2022. All rights reserved.