@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
date="2023-03-14T16:25:20.823Z")
public class CfnComponent
extends CfnResource
implements IInspectable
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();
| Modifier and Type | Class and Description |
|---|---|
static interface |
CfnComponent.ActionParametersProperty
The `ActionParameters` property specifies the event action configuration for an element of a `Component` or `ComponentChild` .
|
static 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
Describes how to bind a component property to form data.
|
static interface |
CfnComponent.MutationActionSetStateParameterProperty
The `MutationActionSetStateParameter` property specifies 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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyIConstruct.Jsii$Default| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnComponent(Construct scope,
java.lang.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) |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getAppId()
The unique ID of the Amplify app associated with the component.
|
java.lang.String |
getAttrId()
The unique ID of the component.
|
java.lang.Object |
getBindingProperties()
The information to connect a component's properties to data at runtime.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getChildren()
A list of the component's `ComponentChild` instances.
|
java.lang.Object |
getCollectionProperties()
The data binding configuration for the component's properties.
|
java.lang.String |
getComponentType()
The type of the component.
|
java.lang.String |
getEnvironmentName()
The name of the backend environment that is a part of the Amplify app.
|
java.lang.Object |
getEvents()
Describes the events that can be raised on the component.
|
java.lang.String |
getName()
The name of the component.
|
java.lang.Object |
getOverrides()
Describes the component's properties that can be overriden in a customized instance of the component.
|
java.lang.Object |
getProperties()
Describes the component's properties.
|
java.lang.String |
getSchemaVersion()
The schema version of the component when it was imported.
|
java.lang.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.
|
java.lang.Object |
getVariants()
A list of the component's variants.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAppId(java.lang.String value)
The unique ID of the Amplify app associated with the component.
|
void |
setBindingProperties(IResolvable value)
The information to connect a component's properties to data at runtime.
|
void |
setBindingProperties(java.util.Map<java.lang.String,java.lang.Object> value)
The information to connect a component's properties to data at runtime.
|
void |
setChildren(IResolvable value)
A list of the component's `ComponentChild` instances.
|
void |
setChildren(java.util.List<java.lang.Object> value)
A list of the component's `ComponentChild` instances.
|
void |
setCollectionProperties(IResolvable value)
The data binding configuration for the component's properties.
|
void |
setCollectionProperties(java.util.Map<java.lang.String,java.lang.Object> value)
The data binding configuration for the component's properties.
|
void |
setComponentType(java.lang.String value)
The type of the component.
|
void |
setEnvironmentName(java.lang.String value)
The name of the backend environment that is a part of the Amplify app.
|
void |
setEvents(IResolvable value)
Describes the events that can be raised on the component.
|
void |
setEvents(java.util.Map<java.lang.String,java.lang.Object> value)
Describes the events that can be raised on the component.
|
void |
setName(java.lang.String value)
The name of the component.
|
void |
setOverrides(java.lang.Object value)
Describes the component's properties that can be overriden in a customized instance of the component.
|
void |
setProperties(IResolvable value)
Describes the component's properties.
|
void |
setProperties(java.util.Map<java.lang.String,java.lang.Object> value)
Describes the component's properties.
|
void |
setSchemaVersion(java.lang.String value)
The schema version of the component when it was imported.
|
void |
setSourceId(java.lang.String value)
The unique ID of the component in its original source system, such as Figma.
|
void |
setVariants(IResolvable value)
A list of the component's variants.
|
void |
setVariants(java.util.List<java.lang.Object> value)
A list of the component's variants.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdgetNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validatepublic static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnComponent(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnComponent(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnComponent(Construct scope, java.lang.String id, CfnComponentProps props)
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.public void inspect(TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties in class CfnResourceprops - This parameter is required.public java.lang.String getAttrId()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties in class CfnResourcepublic TagManager getTags()
public java.lang.Object getBindingProperties()
You can't specify tags as a valid property for bindingProperties .
public void setBindingProperties(IResolvable value)
You can't specify tags as a valid property for bindingProperties .
public void setBindingProperties(java.util.Map<java.lang.String,java.lang.Object> value)
You can't specify tags as a valid property for bindingProperties .
public java.lang.String getComponentType()
This can be an Amplify custom UI component or another custom component.
public void setComponentType(java.lang.String value)
This can be an Amplify custom UI component or another custom component.
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.Object getOverrides()
You can't specify tags as a valid property for overrides .
public void setOverrides(java.lang.Object value)
You can't specify tags as a valid property for overrides .
public java.lang.Object getProperties()
You can't specify tags as a valid property for properties .
public void setProperties(IResolvable value)
You can't specify tags as a valid property for properties .
public void setProperties(java.util.Map<java.lang.String,java.lang.Object> value)
You can't specify tags as a valid property for properties .
public java.lang.Object getVariants()
A variant is a unique style configuration of a main component.
public void setVariants(IResolvable value)
A variant is a unique style configuration of a main component.
public void setVariants(java.util.List<java.lang.Object> value)
A variant is a unique style configuration of a main component.
public java.lang.String getAppId()
public void setAppId(java.lang.String value)
public java.lang.Object getChildren()
public void setChildren(IResolvable value)
public void setChildren(java.util.List<java.lang.Object> value)
public java.lang.Object getCollectionProperties()
Use this for a collection component. You can't specify tags as a valid property for collectionProperties .
public void setCollectionProperties(IResolvable value)
Use this for a collection component. You can't specify tags as a valid property for collectionProperties .
public void setCollectionProperties(java.util.Map<java.lang.String,java.lang.Object> value)
Use this for a collection component. You can't specify tags as a valid property for collectionProperties .
public java.lang.String getEnvironmentName()
public void setEnvironmentName(java.lang.String value)
public java.lang.Object getEvents()
Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
public void setEvents(IResolvable value)
Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
public void setEvents(java.util.Map<java.lang.String,java.lang.Object> value)
Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
public java.lang.String getSchemaVersion()
public void setSchemaVersion(java.lang.String value)
public java.lang.String getSourceId()
public void setSourceId(java.lang.String value)