Interface CfnComponentProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnComponentProps.Jsii$Proxy
CfnComponent.
Example:
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnComponentPropsstatic final classAn implementation forCfnComponentProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnComponentProps.Builderbuilder()default StringgetAppId()The unique ID of the Amplify app associated with the component.default ObjectThe information to connect a component's properties to data at runtime.default ObjectA list of the component'sComponentChildinstances.default ObjectThe data binding configuration for the component's properties.default StringThe type of the component.default StringThe name of the backend environment that is a part of the Amplify app.default ObjectDescribes the events that can be raised on the component.default StringgetName()The name of the component.default ObjectDescribes the component's properties that can be overriden in a customized instance of the component.default ObjectDescribes the component's properties.default StringThe schema version of the component when it was imported.default StringThe unique ID of the component in its original source system, such as Figma.getTags()One or more key-value pairs to use when tagging the component.default ObjectA list of the component's variants.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAppId
The unique ID of the Amplify app associated with the component.- See Also:
-
getBindingProperties
The information to connect a component's properties to data at runtime.You can't specify
tagsas a valid property forbindingProperties.Returns union: either
IResolvableor Mapinvalid input: '<'String, eitherIResolvableorCfnComponent.ComponentBindingPropertiesValueProperty>- See Also:
-
getChildren
A list of the component'sComponentChildinstances.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnComponent.ComponentChildProperty>- See Also:
-
getCollectionProperties
The data binding configuration for the component's properties.Use this for a collection component. You can't specify
tagsas a valid property forcollectionProperties.Returns union: either
IResolvableor Mapinvalid input: '<'String, eitherIResolvableorCfnComponent.ComponentDataConfigurationProperty>- See Also:
-
getComponentType
The type of the component.This can be an Amplify custom UI component or another custom component.
- See Also:
-
getEnvironmentName
The name of the backend environment that is a part of the Amplify app.- See Also:
-
getEvents
Describes the events that can be raised on the component.Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
Returns union: either
IResolvableor Mapinvalid input: '<'String, eitherIResolvableorCfnComponent.ComponentEventProperty>- See Also:
-
getName
The name of the component.- See Also:
-
getOverrides
Describes the component's properties that can be overriden in a customized instance of the component.You can't specify
tagsas a valid property foroverrides.- See Also:
-
getProperties
Describes the component's properties.You can't specify
tagsas a valid property forproperties.Returns union: either
IResolvableor Mapinvalid input: '<'String, eitherIResolvableorCfnComponent.ComponentPropertyProperty>- See Also:
-
getSchemaVersion
The schema version of the component when it was imported.- See Also:
-
getSourceId
The unique ID of the component in its original source system, such as Figma.- See Also:
-
getTags
One or more key-value pairs to use when tagging the component.- See Also:
-
getVariants
A list of the component's variants.A variant is a unique style configuration of a main component.
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnComponent.ComponentVariantProperty>- See Also:
-
builder
- Returns:
- a
CfnComponentProps.BuilderofCfnComponentProps
-