aws-cdk-lib.aws_amplifyuibuilder.CfnComponentProps

interface CfnComponentProps

LanguageType name
.NETAmazon.CDK.AWS.AmplifyUIBuilder.CfnComponentProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsamplifyuibuilder#CfnComponentProps
Javasoftware.amazon.awscdk.services.amplifyuibuilder.CfnComponentProps
Pythonaws_cdk.aws_amplifyuibuilder.CfnComponentProps
TypeScript aws-cdk-lib » aws_amplifyuibuilder » CfnComponentProps

Properties for defining a CfnComponent.

Example

// The generated example for this type would exceed 500 lines,
// and has been elided for readability.

Properties

NameTypeDescription
bindingPropertiesIResolvable | { [string]: IResolvable | ComponentBindingPropertiesValueProperty }The information to connect a component's properties to data at runtime.
componentTypestringThe type of the component.
namestringThe name of the component.
overridesanyDescribes the component's properties that can be overriden in a customized instance of the component.
propertiesIResolvable | { [string]: IResolvable | ComponentPropertyProperty }Describes the component's properties.
variantsIResolvable | IResolvable | ComponentVariantProperty[]A list of the component's variants.
appId?stringThe unique ID of the Amplify app associated with the component.
children?IResolvable | IResolvable | ComponentChildProperty[]A list of the component's ComponentChild instances.
collectionProperties?IResolvable | { [string]: IResolvable | ComponentDataConfigurationProperty }The data binding configuration for the component's properties.
environmentName?stringThe name of the backend environment that is a part of the Amplify app.
events?IResolvable | { [string]: IResolvable | ComponentEventProperty }Describes the events that can be raised on the component.
schemaVersion?stringThe schema version of the component when it was imported.
sourceId?stringThe unique ID of the component in its original source system, such as Figma.
tags?{ [string]: string }One or more key-value pairs to use when tagging the component.

bindingProperties

Type: IResolvable | { [string]: IResolvable | ComponentBindingPropertiesValueProperty }

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

You can't specify tags as a valid property for bindingProperties .


componentType

Type: string

The type of the component.

This can be an Amplify custom UI component or another custom component.


name

Type: string

The name of the component.


overrides

Type: any

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 for overrides .


properties

Type: IResolvable | { [string]: IResolvable | ComponentPropertyProperty }

Describes the component's properties.

You can't specify tags as a valid property for properties .


variants

Type: IResolvable | IResolvable | ComponentVariantProperty[]

A list of the component's variants.

A variant is a unique style configuration of a main component.


appId?

Type: string (optional)

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


children?

Type: IResolvable | IResolvable | ComponentChildProperty[] (optional)

A list of the component's ComponentChild instances.


collectionProperties?

Type: IResolvable | { [string]: IResolvable | ComponentDataConfigurationProperty } (optional)

The data binding configuration for the component's properties.

Use this for a collection component. You can't specify tags as a valid property for collectionProperties .


environmentName?

Type: string (optional)

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


events?

Type: IResolvable | { [string]: IResolvable | ComponentEventProperty } (optional)

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.


schemaVersion?

Type: string (optional)

The schema version of the component when it was imported.


sourceId?

Type: string (optional)

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


tags?

Type: { [string]: string } (optional)

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