Interface CfnComponentProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnComponentProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-23T05:56:10.313Z")
@Stability(Stable)
public interface CfnComponentProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnComponent
.
Example:
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnComponentProps
static final class
An implementation forCfnComponentProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnComponentProps.Builder
builder()
default String
getAppId()
The unique ID of the Amplify app associated with the component.default Object
The information to connect a component's properties to data at runtime.default Object
A list of the component'sComponentChild
instances.default Object
The data binding configuration for the component's properties.default String
The type of the component.default String
The name of the backend environment that is a part of the Amplify app.default Object
Describes the events that can be raised on the component.default String
getName()
The name of the component.default Object
Describes the component's properties that can be overriden in a customized instance of the component.default Object
Describes the component's properties.default String
The schema version of the component when it was imported.default String
The 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 Object
A 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
tags
as a valid property forbindingProperties
.- See Also:
-
getChildren
A list of the component'sComponentChild
instances.- See Also:
-
getCollectionProperties
The data binding configuration for the component's properties.Use this for a collection component. You can't specify
tags
as a valid property forcollectionProperties
.- 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.
- 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
tags
as a valid property foroverrides
.- See Also:
-
getProperties
Describes the component's properties.You can't specify
tags
as a valid property forproperties
.- 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.
- See Also:
-
builder
- Returns:
- a
CfnComponentProps.Builder
ofCfnComponentProps
-