Package software.amazon.awscdk.services.amplifyuibuilder

Interface CfnComponent.ComponentEventProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnComponent.ComponentEventProperty.Jsii$Proxy

Enclosing class:

CfnComponent

@Stability(Stable)
public static interface CfnComponent.ComponentEventProperty
extends software.amazon.jsii.JsiiSerializable

The ComponentEvent property specifies the configuration of an event.

You can bind an event and a corresponding action to a Component or a ComponentChild . A button click is an example of an event.

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_;
 ComponentEventProperty componentEventProperty = ComponentEventProperty.builder()
         .action("action")
         .bindingEvent("bindingEvent")
         .parameters(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())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentevent.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnComponent.ComponentEventProperty.Builder	A builder for CfnComponent.ComponentEventProperty
static final class	CfnComponent.ComponentEventProperty.Jsii$Proxy	An implementation for CfnComponent.ComponentEventProperty

Method Summary

Modifier and Type	Method	Description
static CfnComponent.ComponentEventProperty.Builder	builder()
default String	getAction()	The action to perform when a specific event is raised.
default String	getBindingEvent()	Binds an event to an action on a component.
default Object	getParameters()	Describes information about the action.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAction

@Stability(Stable)
@Nullable
default String getAction()

The action to perform when a specific event is raised.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentevent.html#cfn-amplifyuibuilder-component-componentevent-action

getBindingEvent

@Stability(Stable)
@Nullable
default String getBindingEvent()

Binds an event to an action on a component.

When you specify a bindingEvent , the event is called when the action is performed.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentevent.html#cfn-amplifyuibuilder-component-componentevent-bindingevent

getParameters

@Stability(Stable)
@Nullable
default Object getParameters()

Describes information about the action.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentevent.html#cfn-amplifyuibuilder-component-componentevent-parameters

builder

@Stability(Stable)
static CfnComponent.ComponentEventProperty.Builder builder()

Returns:

a CfnComponent.ComponentEventProperty.Builder of CfnComponent.ComponentEventProperty