@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:36.054Z") @Stability(value=Stable) public interface CfnComponentProps extends software.amazon.jsii.JsiiSerializable
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.*;
Object bindings;
ComponentChildProperty componentChildProperty_;
ComponentPropertyProperty componentPropertyProperty_;
Object events;
Object fields;
Object overrides;
PredicateProperty predicateProperty_;
Object properties;
Object variantValues;
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()))
.componentType("componentType")
.name("name")
.overrides(Map.of(
"overridesKey", overrides))
.properties(Map.of(
"propertiesKey", ComponentPropertyProperty.builder()
.bindingProperties(ComponentPropertyBindingPropertiesProperty.builder()
.property("property")
// the properties below are optional
.field("field")
.build())
.bindings(bindings)
.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(variantValues)
.build()))
// 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()))
.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()))
.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(bindings)
.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(fields)
.global(ComponentPropertyProperty.builder()
.bindingProperties(ComponentPropertyBindingPropertiesProperty.builder()
.property("property")
// the properties below are optional
.field("field")
.build())
.bindings(bindings)
.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(bindings)
.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(bindings)
.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(bindings)
.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(bindings)
.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(bindings)
.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();
| Modifier and Type | Interface and Description |
|---|---|
static class |
CfnComponentProps.Builder
A builder for
CfnComponentProps |
static class |
CfnComponentProps.Jsii$Proxy
An implementation for
CfnComponentProps |
| Modifier and Type | Method and Description |
|---|---|
static CfnComponentProps.Builder |
builder() |
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.
|
String |
getComponentType()
The type of the component.
|
default 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.
|
default String |
getSchemaVersion()
The schema version of the component when it was imported.
|
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.
|
Object |
getVariants()
A list of the component's variants.
|
@Stability(value=Stable) @NotNull Object getBindingProperties()
You can't specify tags as a valid property for bindingProperties .
@Stability(value=Stable) @NotNull String getComponentType()
This can be an Amplify custom UI component or another custom component.
@Stability(value=Stable) @NotNull String getName()
@Stability(value=Stable) @NotNull Object getOverrides()
You can't specify tags as a valid property for overrides .
@Stability(value=Stable) @NotNull Object getProperties()
You can't specify tags as a valid property for properties .
@Stability(value=Stable) @NotNull Object getVariants()
A variant is a unique style configuration of a main component.
@Stability(value=Stable) @Nullable default Object getChildren()
@Stability(value=Stable) @Nullable default Object getCollectionProperties()
Use this for a collection component. You can't specify tags as a valid property for collectionProperties .
@Stability(value=Stable) @Nullable default Object getEvents()
Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
@Stability(value=Stable) @Nullable default String getSchemaVersion()
@Stability(value=Stable) @Nullable default String getSourceId()
@Stability(value=Stable) @Nullable default Map<String,String> getTags()
@Stability(value=Stable) static CfnComponentProps.Builder builder()
CfnComponentProps.Builder of CfnComponentPropsCopyright © 2022. All rights reserved.