@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:36.041Z") @Stability(value=Stable) 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.*;
Object bindings;
ComponentChildProperty componentChildProperty_;
ComponentPropertyProperty componentPropertyProperty_;
Object events;
Object fields;
Object overrides;
PredicateProperty predicateProperty_;
Object properties;
Object variantValues;
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(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 | 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.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.
|
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$Proxy| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnComponent(software.constructs.Construct scope,
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 |
|---|---|
String |
getAttrAppId()
The unique ID for the Amplify app.
|
String |
getAttrEnvironmentName()
The name of the backend environment that is a part of the Amplify app.
|
String |
getAttrId()
The unique ID of the component.
|
Object |
getBindingProperties()
The information to connect a component's properties to data at runtime.
|
protected Map<String,Object> |
getCfnProperties() |
Object |
getChildren()
A list of the component's `ComponentChild` instances.
|
Object |
getCollectionProperties()
The data binding configuration for the component's properties.
|
String |
getComponentType()
The type of the component.
|
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.
|
String |
getSchemaVersion()
The schema version of the component when it was imported.
|
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.
|
Object |
getVariants()
A list of the component's variants.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected Map<String,Object> |
renderProperties(Map<String,Object> props) |
void |
setBindingProperties(IResolvable value)
The information to connect a component's properties to data at runtime.
|
void |
setBindingProperties(Map<String,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(List<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(Map<String,Object> value)
The data binding configuration for the component's properties.
|
void |
setComponentType(String value)
The type of the component.
|
void |
setEvents(IResolvable value)
Describes the events that can be raised on the component.
|
void |
setEvents(Map<String,Object> value)
Describes the events that can be raised on the component.
|
void |
setName(String value)
The name of the component.
|
void |
setOverrides(IResolvable value)
Describes the component's properties that can be overriden in a customized instance of the component.
|
void |
setOverrides(Map<String,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(Map<String,Object> value)
Describes the component's properties.
|
void |
setSchemaVersion(String value)
The schema version of the component when it was imported.
|
void |
setSourceId(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(List<Object> value)
A list of the component's variants.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdjsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnComponent(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnComponent(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnComponent(@NotNull
software.constructs.Construct scope,
@NotNull
String id,
@NotNull
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.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull public String getAttrAppId()
@Stability(value=Stable) @NotNull public String getAttrEnvironmentName()
@Stability(value=Stable) @NotNull public String getAttrId()
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public TagManager getTags()
@Stability(value=Stable) @NotNull public Object getBindingProperties()
You can't specify tags as a valid property for bindingProperties .
@Stability(value=Stable)
public void setBindingProperties(@NotNull
IResolvable value)
You can't specify tags as a valid property for bindingProperties .
@Stability(value=Stable)
public void setBindingProperties(@NotNull
Map<String,Object> value)
You can't specify tags as a valid property for bindingProperties .
@Stability(value=Stable) @NotNull public String getComponentType()
This can be an Amplify custom UI component or another custom component.
@Stability(value=Stable)
public void setComponentType(@NotNull
String value)
This can be an Amplify custom UI component or another custom component.
@Stability(value=Stable) @NotNull public String getName()
@Stability(value=Stable)
public void setName(@NotNull
String value)
@Stability(value=Stable) @NotNull public Object getOverrides()
You can't specify tags as a valid property for overrides .
@Stability(value=Stable)
public void setOverrides(@NotNull
IResolvable value)
You can't specify tags as a valid property for overrides .
@Stability(value=Stable)
public void setOverrides(@NotNull
Map<String,Object> value)
You can't specify tags as a valid property for overrides .
@Stability(value=Stable) @NotNull public Object getProperties()
You can't specify tags as a valid property for properties .
@Stability(value=Stable)
public void setProperties(@NotNull
IResolvable value)
You can't specify tags as a valid property for properties .
@Stability(value=Stable)
public void setProperties(@NotNull
Map<String,Object> value)
You can't specify tags as a valid property for properties .
@Stability(value=Stable) @NotNull public Object getVariants()
A variant is a unique style configuration of a main component.
@Stability(value=Stable)
public void setVariants(@NotNull
IResolvable value)
A variant is a unique style configuration of a main component.
@Stability(value=Stable)
public void setVariants(@NotNull
List<Object> value)
A variant is a unique style configuration of a main component.
@Stability(value=Stable) @Nullable public Object getChildren()
@Stability(value=Stable)
public void setChildren(@Nullable
IResolvable value)
@Stability(value=Stable)
public void setChildren(@Nullable
List<Object> value)
@Stability(value=Stable) @Nullable public Object getCollectionProperties()
Use this for a collection component. You can't specify tags as a valid property for collectionProperties .
@Stability(value=Stable)
public void setCollectionProperties(@Nullable
IResolvable value)
Use this for a collection component. You can't specify tags as a valid property for collectionProperties .
@Stability(value=Stable)
public void setCollectionProperties(@Nullable
Map<String,Object> value)
Use this for a collection component. You can't specify tags as a valid property for collectionProperties .
@Stability(value=Stable) @Nullable public Object getEvents()
Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
@Stability(value=Stable)
public void setEvents(@Nullable
IResolvable value)
Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
@Stability(value=Stable)
public void setEvents(@Nullable
Map<String,Object> value)
Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
@Stability(value=Stable) @Nullable public String getSchemaVersion()
@Stability(value=Stable)
public void setSchemaVersion(@Nullable
String value)
@Stability(value=Stable) @Nullable public String getSourceId()
@Stability(value=Stable)
public void setSourceId(@Nullable
String value)
Copyright © 2022. All rights reserved.