software.amazon.awscdk.services.amplifyuibuilder

Interface CfnComponentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnComponentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:01.440Z")
 @Stability(value=Stable)
public interface CfnComponentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnComponent`.

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_;
 PredicateProperty predicateProperty_;
 CfnComponentProps cfnComponentProps = CfnComponentProps.builder()
         .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()))
         .children(List.of(ComponentChildProperty.builder()
                 .componentType("componentType")
                 .name("name")
                 .properties(ComponentPropertiesProperty.builder().build())
                 // the properties below are optional
                 .children(List.of(componentChildProperty_))
                 .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()))
         .componentType("componentType")
         .name("name")
         .overrides(Map.of(
                 "overridesKey", ComponentOverridesValueProperty.builder().build()))
         .properties(Map.of(
                 "propertiesKey", ComponentPropertyProperty.builder()
                         .bindingProperties(ComponentPropertyBindingPropertiesProperty.builder()
                                 .property("property")
                                 // the properties below are optional
                                 .field("field")
                                 .build())
                         .bindings(FormBindingsProperty.builder().build())
                         .collectionBindingProperties(ComponentPropertyBindingPropertiesProperty.builder()
                                 .property("property")
                                 // the properties below are optional
                                 .field("field")
                                 .build())
                         .concat(List.of(componentPropertyProperty_))
                         .condition(ComponentConditionPropertyProperty.builder()
                                 .else(componentPropertyProperty_)
                                 .field("field")
                                 .operand("operand")
                                 .operator("operator")
                                 .property("property")
                                 .then(componentPropertyProperty_)
                                 .build())
                         .configured(false)
                         .defaultValue("defaultValue")
                         .event("event")
                         .importedValue("importedValue")
                         .model("model")
                         .type("type")
                         .userAttribute("userAttribute")
                         .value("value")
                         .build()))
         .sourceId("sourceId")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .variants(List.of(ComponentVariantProperty.builder()
                 .overrides(ComponentOverridesProperty.builder().build())
                 .variantValues(ComponentVariantValuesProperty.builder().build())
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnComponentProps.Builder	builder()
default Object	getBindingProperties() The information to connect a component's properties to data at runtime.
default Object	getChildren() A list of the component's `ComponentChild` instances.
default Object	getCollectionProperties() The data binding configuration for the component's properties.
default String	getComponentType() The type of the component.
default String	getName() The name of the component.
default Object	getOverrides() Describes the component's properties that can be overriden in a customized instance of the component.
default Object	getProperties() Describes the component's properties.
default String	getSourceId() The unique ID of the component in its original source system, such as Figma.
default Map<String,String>	getTags() One or more key-value pairs to use when tagging the component.
default Object	getVariants() A list of the component's variants.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBindingProperties

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

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

getChildren

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

A list of the component's `ComponentChild` instances.

getCollectionProperties

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

The data binding configuration for the component's properties.

Use this for a collection component.

getComponentType

@Stability(value=Stable)
 @Nullable
default String getComponentType()

The type of the component.

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

getName

@Stability(value=Stable)
 @Nullable
default String getName()

The name of the component.

getOverrides

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

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

getProperties

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

Describes the component's properties.

getSourceId

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

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

getTags

@Stability(value=Stable)
 @Nullable
default Map<String,String> getTags()

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

getVariants

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

A list of the component's variants.

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

builder

@Stability(value=Stable)
static CfnComponentProps.Builder builder()

Returns:

a CfnComponentProps.Builder of CfnComponentProps