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(value=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_;
 Object events;
 Object properties;
 ComponentChildProperty componentChildProperty = ComponentChildProperty.builder()
         .componentType("componentType")
         .name("name")
         .properties(properties)
         // the properties below are optional
         .children(List.of(ComponentChildProperty.builder()
                 .componentType("componentType")
                 .name("name")
                 .properties(properties)
                 // the properties below are optional
                 .children(List.of(componentChildProperty_))
                 .events(events)
                 .build()))
         .events(events)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and 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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getComponentType

@Stability(value=Stable)
 @NotNull
String getComponentType()

The type of the child component.

getName

@Stability(value=Stable)
 @NotNull
String getName()

The name of the child component.

getProperties

@Stability(value=Stable)
 @NotNull
Object getProperties()

Describes the properties of the child component.

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

getChildren

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

The list of `ComponentChild` instances for this component.

getEvents

@Stability(value=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.

builder

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

Returns:

a CfnComponent.ComponentChildProperty.Builder of CfnComponent.ComponentChildProperty