Package software.amazon.awscdk.services.amplifyuibuilder

Class CfnComponent

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.amplifyuibuilder.CfnComponent

All Implemented Interfaces:

IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:55.347Z")
@Stability(Stable)
public class CfnComponent
extends CfnResource
implements IInspectable

A CloudFormation AWS::AmplifyUIBuilder::Component.

The AWS::AmplifyUIBuilder::Component resource specifies a component within an Amplify app. A component is a user interface (UI) element that you can customize. Use ComponentChild to configure an instance of a Component . A ComponentChild instance inherits the configuration of the main 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.*;
 ComponentChildProperty componentChildProperty_;
 ComponentPropertyProperty componentPropertyProperty_;
 Object overrides;
 PredicateProperty predicateProperty_;
 CfnComponent cfnComponent = CfnComponent.Builder.create(this, "MyCfnComponent")
         .bindingProperties(Map.of(
                 "bindingPropertiesKey", ComponentBindingPropertiesValueProperty.builder()
                         .bindingProperties(ComponentBindingPropertiesValuePropertiesProperty.builder()
                                 .bucket("bucket")
                                 .defaultValue("defaultValue")
                                 .field("field")
                                 .key("key")
                                 .model("model")
                                 .predicates(List.of(PredicateProperty.builder()
                                         .and(List.of(predicateProperty_))
                                         .field("field")
                                         .operand("operand")
                                         .operator("operator")
                                         .or(List.of(predicateProperty_))
                                         .build()))
                                 .userAttribute("userAttribute")
                                 .build())
                         .defaultValue("defaultValue")
                         .type("type")
                         .build()))
         .componentType("componentType")
         .name("name")
         .overrides(overrides)
         .properties(Map.of(
                 "propertiesKey", 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()))
         .variants(List.of(ComponentVariantProperty.builder()
                 .overrides(overrides)
                 .variantValues(Map.of(
                         "variantValuesKey", "variantValues"))
                 .build()))
         // the properties below are optional
         .appId("appId")
         .children(List.of(ComponentChildProperty.builder()
                 .componentType("componentType")
                 .name("name")
                 .properties(Map.of(
                         "propertiesKey", 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()))
                 // the properties below are optional
                 .children(List.of(componentChildProperty_))
                 .events(Map.of(
                         "eventsKey", ComponentEventProperty.builder()
                                 .action("action")
                                 .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()))
                 .build()))
         .collectionProperties(Map.of(
                 "collectionPropertiesKey", ComponentDataConfigurationProperty.builder()
                         .model("model")
                         // the properties below are optional
                         .identifiers(List.of("identifiers"))
                         .predicate(PredicateProperty.builder()
                                 .and(List.of(predicateProperty_))
                                 .field("field")
                                 .operand("operand")
                                 .operator("operator")
                                 .or(List.of(predicateProperty_))
                                 .build())
                         .sort(List.of(SortPropertyProperty.builder()
                                 .direction("direction")
                                 .field("field")
                                 .build()))
                         .build()))
         .environmentName("environmentName")
         .events(Map.of(
                 "eventsKey", ComponentEventProperty.builder()
                         .action("action")
                         .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()))
         .schemaVersion("schemaVersion")
         .sourceId("sourceId")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnComponent.ActionParametersProperty	Represents the event action configuration for an element of a Component or ComponentChild .
static final class	CfnComponent.Builder	A fluent builder for CfnComponent.
static interface	CfnComponent.ComponentBindingPropertiesValuePropertiesProperty	The ComponentBindingPropertiesValueProperties property specifies the data binding configuration for a specific property using data stored in AWS .
static interface	CfnComponent.ComponentBindingPropertiesValueProperty	The ComponentBindingPropertiesValue property specifies the data binding configuration for a component at runtime.
static interface	CfnComponent.ComponentChildProperty	The ComponentChild property specifies a nested UI configuration within a parent Component .
static interface	CfnComponent.ComponentConditionPropertyProperty	The ComponentConditionProperty property specifies a conditional expression for setting a component property.
static interface	CfnComponent.ComponentDataConfigurationProperty	The ComponentDataConfiguration property specifies the configuration for binding a component's properties to data.
static interface	CfnComponent.ComponentEventProperty	The ComponentEvent property specifies the configuration of an event.
static interface	CfnComponent.ComponentPropertyBindingPropertiesProperty	The ComponentPropertyBindingProperties property specifies a component property to associate with a binding property.
static interface	CfnComponent.ComponentPropertyProperty	The ComponentProperty property specifies the configuration for all of a component's properties.
static interface	CfnComponent.ComponentVariantProperty	The ComponentVariant property specifies the style configuration of a unique variation of a main component.
static interface	CfnComponent.FormBindingElementProperty	Example:
static interface	CfnComponent.MutationActionSetStateParameterProperty	Represents the state configuration when an action modifies a property of another element within the same component.
static interface	CfnComponent.PredicateProperty	The Predicate property specifies information for generating Amplify DataStore queries.
static interface	CfnComponent.SortPropertyProperty	The SortProperty property specifies how to sort the data that you bind to a component.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnComponent(Construct scope, String id, CfnComponentProps props)	Create a new AWS::AmplifyUIBuilder::Component.
protected	CfnComponent(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnComponent(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
String	getAppId()	AWS::AmplifyUIBuilder::Component.AppId.
String	getAttrId()	The unique ID of the component.
Object	getBindingProperties()	The information to connect a component's properties to data at runtime.
protected Map<String,Object>	getCfnProperties()
Object	getChildren()	A list of the component's ComponentChild instances.
Object	getCollectionProperties()	The data binding configuration for the component's properties.
String	getComponentType()	The type of the component.
String	getEnvironmentName()	AWS::AmplifyUIBuilder::Component.EnvironmentName.
Object	getEvents()	Describes the events that can be raised on the component.
String	getName()	The name of the component.
Object	getOverrides()	Describes the component's properties that can be overriden in a customized instance of the component.
Object	getProperties()	Describes the component's properties.
String	getSchemaVersion()	The schema version of the component when it was imported.
String	getSourceId()	The unique ID of the component in its original source system, such as Figma.
TagManager	getTags()	One or more key-value pairs to use when tagging the component.
Object	getVariants()	A list of the component's variants.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAppId(String value)	AWS::AmplifyUIBuilder::Component.AppId.
void	setBindingProperties(Map<String,Object> value)	The information to connect a component's properties to data at runtime.
void	setBindingProperties(IResolvable value)	The information to connect a component's properties to data at runtime.
void	setChildren(List<Object> value)	A list of the component's ComponentChild instances.
void	setChildren(IResolvable value)	A list of the component's ComponentChild instances.
void	setCollectionProperties(Map<String,Object> value)	The data binding configuration for the component's properties.
void	setCollectionProperties(IResolvable value)	The data binding configuration for the component's properties.
void	setComponentType(String value)	The type of the component.
void	setEnvironmentName(String value)	AWS::AmplifyUIBuilder::Component.EnvironmentName.
void	setEvents(Map<String,Object> value)	Describes the events that can be raised on the component.
void	setEvents(IResolvable value)	Describes the events that can be raised on the component.
void	setName(String value)	The name of the component.
void	setOverrides(Object value)	Describes the component's properties that can be overriden in a customized instance of the component.
void	setProperties(Map<String,Object> value)	Describes the component's properties.
void	setProperties(IResolvable value)	Describes the component's properties.
void	setSchemaVersion(String value)	The schema version of the component when it was imported.
void	setSourceId(String value)	The unique ID of the component in its original source system, such as Figma.
void	setVariants(List<Object> value)	A list of the component's variants.
void	setVariants(IResolvable value)	A list of the component's variants.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnComponent

protected CfnComponent(software.amazon.jsii.JsiiObjectRef objRef)

CfnComponent

protected CfnComponent(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnComponent

@Stability(Stable)
public CfnComponent(@NotNull
 Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnComponentProps props)

Create a new AWS::AmplifyUIBuilder::Component.

Parameters:

scope -

• scope in which this resource is defined.

This parameter is required.

id -

• scoped id of the resource.

This parameter is required.

props -

• resource properties.

This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector -

• tree inspector to collect and process attributes.

This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

The unique ID of the component.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

One or more key-value pairs to use when tagging the component.

getBindingProperties

@Stability(Stable)
@NotNull
public Object getBindingProperties()

The information to connect a component's properties to data at runtime.

You can't specify tags as a valid property for bindingProperties .

setBindingProperties

@Stability(Stable)
public void setBindingProperties(@NotNull
 IResolvable value)

The information to connect a component's properties to data at runtime.

You can't specify tags as a valid property for bindingProperties .

setBindingProperties

@Stability(Stable)
public void setBindingProperties(@NotNull
 Map<String,Object> value)

The information to connect a component's properties to data at runtime.

You can't specify tags as a valid property for bindingProperties .

getComponentType

@Stability(Stable)
@NotNull
public String getComponentType()

The type of the component.

This can be an Amplify custom UI component or another custom component.

setComponentType

@Stability(Stable)
public void setComponentType(@NotNull
 String value)

The type of the component.

This can be an Amplify custom UI component or another custom component.

getName

@Stability(Stable)
@NotNull
public String getName()

The name of the component.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

The name of the component.

getOverrides

@Stability(Stable)
@NotNull
public Object getOverrides()

Describes the component's properties that can be overriden in a customized instance of the component.

You can't specify tags as a valid property for overrides .

setOverrides

@Stability(Stable)
public void setOverrides(@NotNull
 Object value)

Describes the component's properties that can be overriden in a customized instance of the component.

You can't specify tags as a valid property for overrides .

getProperties

@Stability(Stable)
@NotNull
public Object getProperties()

Describes the component's properties.

You can't specify tags as a valid property for properties .

setProperties

@Stability(Stable)
public void setProperties(@NotNull
 IResolvable value)

Describes the component's properties.

You can't specify tags as a valid property for properties .

setProperties

@Stability(Stable)
public void setProperties(@NotNull
 Map<String,Object> value)

Describes the component's properties.

You can't specify tags as a valid property for properties .

getVariants

@Stability(Stable)
@NotNull
public Object getVariants()

A list of the component's variants.

A variant is a unique style configuration of a main component.

setVariants

@Stability(Stable)
public void setVariants(@NotNull
 IResolvable value)

A list of the component's variants.

A variant is a unique style configuration of a main component.

setVariants

@Stability(Stable)
public void setVariants(@NotNull
 List<Object> value)

A list of the component's variants.

A variant is a unique style configuration of a main component.

getAppId

@Stability(Stable)
@Nullable
public String getAppId()

AWS::AmplifyUIBuilder::Component.AppId.

setAppId

@Stability(Stable)
public void setAppId(@Nullable
 String value)

AWS::AmplifyUIBuilder::Component.AppId.

getChildren

@Stability(Stable)
@Nullable
public Object getChildren()

A list of the component's ComponentChild instances.

setChildren

@Stability(Stable)
public void setChildren(@Nullable
 IResolvable value)

A list of the component's ComponentChild instances.

setChildren

@Stability(Stable)
public void setChildren(@Nullable
 List<Object> value)

A list of the component's ComponentChild instances.

getCollectionProperties

@Stability(Stable)
@Nullable
public Object getCollectionProperties()

The data binding configuration for the component's properties.

Use this for a collection component. You can't specify tags as a valid property for collectionProperties .

setCollectionProperties

@Stability(Stable)
public void setCollectionProperties(@Nullable
 IResolvable value)

The data binding configuration for the component's properties.

Use this for a collection component. You can't specify tags as a valid property for collectionProperties .

setCollectionProperties

@Stability(Stable)
public void setCollectionProperties(@Nullable
 Map<String,Object> value)

The data binding configuration for the component's properties.

Use this for a collection component. You can't specify tags as a valid property for collectionProperties .

getEnvironmentName

@Stability(Stable)
@Nullable
public String getEnvironmentName()

AWS::AmplifyUIBuilder::Component.EnvironmentName.

setEnvironmentName

@Stability(Stable)
public void setEnvironmentName(@Nullable
 String value)

AWS::AmplifyUIBuilder::Component.EnvironmentName.

getEvents

@Stability(Stable)
@Nullable
public Object getEvents()

Describes the events that can be raised on the component.

Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

setEvents

@Stability(Stable)
public void setEvents(@Nullable
 IResolvable value)

Describes the events that can be raised on the component.

Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

setEvents

@Stability(Stable)
public void setEvents(@Nullable
 Map<String,Object> value)

Describes the events that can be raised on the component.

Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

getSchemaVersion

@Stability(Stable)
@Nullable
public String getSchemaVersion()

The schema version of the component when it was imported.

setSchemaVersion

@Stability(Stable)
public void setSchemaVersion(@Nullable
 String value)

The schema version of the component when it was imported.

getSourceId

@Stability(Stable)
@Nullable
public String getSourceId()

The unique ID of the component in its original source system, such as Figma.

setSourceId

@Stability(Stable)
public void setSourceId(@Nullable
 String value)

The unique ID of the component in its original source system, such as Figma.