Package software.amazon.awscdk.services.amplifyuibuilder

Class CfnComponent

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.amplifyuibuilder.CfnComponent

All Implemented Interfaces:

IInspectable, IComponentRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:03.980Z")
@Stability(Stable)
public class CfnComponent
extends CfnResource
implements IInspectable, IComponentRef, ITaggable

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:

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnComponent.ActionParametersProperty	Represents the event action configuration for an element of a Component or ComponentChild .
static final 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	Represents 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.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.amplifyuibuilder.IComponentRef

IComponentRef.Jsii$Default, IComponentRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnComponent(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnComponent(software.amazon.jsii.JsiiObjectRef objRef)
	CfnComponent(software.constructs.Construct scope, String id)	Create a new AWS::AmplifyUIBuilder::Component.
	CfnComponent(software.constructs.Construct scope, String id, CfnComponentProps props)	Create a new AWS::AmplifyUIBuilder::Component.

Method Summary

Modifier and Type	Method	Description
String	getAppId()	The unique ID of the Amplify app associated with the component.
String	getAttrCreatedAt()	The time that the component was created.
String	getAttrId()	The unique ID of the component.
String	getAttrModifiedAt()	The time that the component was modified.
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.
ComponentReference	getComponentRef()	A reference to a Component resource.
String	getComponentType()	The type of the component.
String	getEnvironmentName()	The name of the backend environment that is a part of the Amplify app.
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()	Tag Manager which manages the tags for this resource.
Map<String,String>	getTagsRaw()	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.
static Boolean	isCfnComponent(Object x)	Checks whether the given object is a CfnComponent.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAppId(String value)	The unique ID of the Amplify app associated with the component.
void	setBindingProperties(Map<String,Object> value)	The information to connect a component's properties to data at runtime.
void	setBindingProperties(IResolvable value)	The information to connect a component's properties to data at runtime.
void	setChildren(List<Object> value)	A list of the component's ComponentChild instances.
void	setChildren(IResolvable value)	A list of the component's ComponentChild instances.
void	setCollectionProperties(Map<String,Object> value)	The data binding configuration for the component's properties.
void	setCollectionProperties(IResolvable value)	The data binding configuration for the component's properties.
void	setComponentType(String value)	The type of the component.
void	setEnvironmentName(String value)	The name of the backend environment that is a part of the Amplify app.
void	setEvents(Map<String,Object> value)	Describes the events that can be raised on the component.
void	setEvents(IResolvable value)	Describes the events that can be raised on the component.
void	setName(String value)	The name of the component.
void	setOverrides(Object value)	Describes the component's properties that can be overriden in a customized instance of the component.
void	setProperties(Map<String,Object> value)	Describes the component's properties.
void	setProperties(IResolvable 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	setTagsRaw(Map<String,String> value)	One or more key-value pairs to use when tagging the component.
void	setVariants(List<Object> value)	A list of the component's variants.
void	setVariants(IResolvable value)	A list of the component's variants.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnComponent

protected CfnComponent(software.amazon.jsii.JsiiObjectRef objRef)

CfnComponent

protected CfnComponent(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnComponent

@Stability(Stable)
public CfnComponent(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnComponentProps props)

Create a new AWS::AmplifyUIBuilder::Component.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties.

CfnComponent

@Stability(Stable)
public CfnComponent(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Create a new AWS::AmplifyUIBuilder::Component.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Method Details

isCfnComponent

@Stability(Stable)
@NotNull
public static Boolean isCfnComponent(@NotNull
 Object x)

Checks whether the given object is a CfnComponent.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCreatedAt

@Stability(Stable)
@NotNull
public String getAttrCreatedAt()

The time that the component was created.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

The unique ID of the component.

getAttrModifiedAt

@Stability(Stable)
@NotNull
public String getAttrModifiedAt()

The time that the component was modified.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getComponentRef

@Stability(Stable)
@NotNull
public ComponentReference getComponentRef()

A reference to a Component resource.

Specified by:

getComponentRef in interface IComponentRef

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getAppId

@Stability(Stable)
@Nullable
public String getAppId()

The unique ID of the Amplify app associated with the component.

setAppId

@Stability(Stable)
public void setAppId(@Nullable
 String value)

The unique ID of the Amplify app associated with the component.

getBindingProperties

@Stability(Stable)
@Nullable
public Object getBindingProperties()

The information to connect a component's properties to data at runtime.

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnComponent.ComponentBindingPropertiesValueProperty>

setBindingProperties

@Stability(Stable)
public void setBindingProperties(@Nullable
 IResolvable value)

The information to connect a component's properties to data at runtime.

setBindingProperties

@Stability(Stable)
public void setBindingProperties(@Nullable
 Map<String,Object> value)

The information to connect a component's properties to data at runtime.

getChildren

@Stability(Stable)
@Nullable
public Object getChildren()

A list of the component's ComponentChild instances.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnComponent.ComponentChildProperty>

setChildren

@Stability(Stable)
public void setChildren(@Nullable
 IResolvable value)

A list of the component's ComponentChild instances.

setChildren

@Stability(Stable)
public void setChildren(@Nullable
 List<Object> value)

A list of the component's ComponentChild instances.

getCollectionProperties

@Stability(Stable)
@Nullable
public Object getCollectionProperties()

The data binding configuration for the component's properties.

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnComponent.ComponentDataConfigurationProperty>

setCollectionProperties

@Stability(Stable)
public void setCollectionProperties(@Nullable
 IResolvable value)

The data binding configuration for the component's properties.

setCollectionProperties

@Stability(Stable)
public void setCollectionProperties(@Nullable
 Map<String,Object> value)

The data binding configuration for the component's properties.

getComponentType

@Stability(Stable)
@Nullable
public String getComponentType()

The type of the component.

setComponentType

@Stability(Stable)
public void setComponentType(@Nullable
 String value)

The type of the component.

getEnvironmentName

@Stability(Stable)
@Nullable
public String getEnvironmentName()

The name of the backend environment that is a part of the Amplify app.

setEnvironmentName

@Stability(Stable)
public void setEnvironmentName(@Nullable
 String value)

The name of the backend environment that is a part of the Amplify app.

getEvents

@Stability(Stable)
@Nullable
public Object getEvents()

Describes the events that can be raised on the component.

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnComponent.ComponentEventProperty>

setEvents

@Stability(Stable)
public void setEvents(@Nullable
 IResolvable value)

Describes the events that can be raised on the component.

setEvents

@Stability(Stable)
public void setEvents(@Nullable
 Map<String,Object> value)

Describes the events that can be raised on the component.

getName

@Stability(Stable)
@Nullable
public String getName()

The name of the component.

setName

@Stability(Stable)
public void setName(@Nullable
 String value)

The name of the component.

getOverrides

@Stability(Stable)
@Nullable
public Object getOverrides()

Describes the component's properties that can be overriden in a customized instance of the component.

setOverrides

@Stability(Stable)
public void setOverrides(@Nullable
 Object value)

Describes the component's properties that can be overriden in a customized instance of the component.

getProperties

@Stability(Stable)
@Nullable
public Object getProperties()

Describes the component's properties.

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnComponent.ComponentPropertyProperty>

setProperties

@Stability(Stable)
public void setProperties(@Nullable
 IResolvable value)

Describes the component's properties.

setProperties

@Stability(Stable)
public void setProperties(@Nullable
 Map<String,Object> value)

Describes the component's properties.

getSchemaVersion

@Stability(Stable)
@Nullable
public String getSchemaVersion()

The schema version of the component when it was imported.

setSchemaVersion

@Stability(Stable)
public void setSchemaVersion(@Nullable
 String value)

The schema version of the component when it was imported.

getSourceId

@Stability(Stable)
@Nullable
public String getSourceId()

The unique ID of the component in its original source system, such as Figma.

setSourceId

@Stability(Stable)
public void setSourceId(@Nullable
 String value)

The unique ID of the component in its original source system, such as Figma.

getTagsRaw

@Stability(Stable)
@Nullable
public Map<String,String> getTagsRaw()

One or more key-value pairs to use when tagging the component.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 Map<String,String> value)

One or more key-value pairs to use when tagging the component.

getVariants

@Stability(Stable)
@Nullable
public Object getVariants()

A list of the component's variants.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnComponent.ComponentVariantProperty>

setVariants

@Stability(Stable)
public void setVariants(@Nullable
 IResolvable value)

A list of the component's variants.

setVariants

@Stability(Stable)
public void setVariants(@Nullable
 List<Object> value)

A list of the component's variants.