Package software.amazon.awscdk.services.amplifyuibuilder

Interface CfnComponent.ComponentChildProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnComponent.ComponentChildProperty.Jsii$Proxy

Enclosing class:

CfnComponent

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

The ComponentChild property specifies a nested UI configuration within a parent 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_;
 ComponentChildProperty componentChildProperty = 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")
                         .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()))
         .sourceId("sourceId")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnComponent.ComponentChildProperty.Builder	builder()
default Object	getChildren()	The list of ComponentChild instances for this component.
String	getComponentType()	The type of the child component.
default Object	getEvents()	Describes the events that can be raised on the child component.
String	getName()	The name of the child component.
Object	getProperties()	Describes the properties of the child component.
default String	getSourceId()	The unique ID of the child component in its original source system, such as Figma.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComponentType

@Stability(Stable)
@NotNull
String getComponentType()

The type of the child component.

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

The name of the child component.

See Also:

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

getProperties

@Stability(Stable)
@NotNull
Object getProperties()

Describes the properties of the child component.

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

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnComponent.ComponentPropertyProperty>

See Also:

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

getChildren

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

The list of ComponentChild instances for this component.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnComponent.ComponentChildProperty>

See Also:

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

getEvents

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

Describes the events that can be raised on the child component.

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

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnComponent.ComponentEventProperty>

See Also:

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

getSourceId

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

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

See Also:

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

builder

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

Returns:

a CfnComponent.ComponentChildProperty.Builder of CfnComponent.ComponentChildProperty