AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::AmplifyUIBuilder::Component

CfnComponent

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` .

Import

import { CfnComponent } from 'aws-cdk-lib/aws-amplifyuibuilder';

Or use the module namespace:

import * as amplifyuibuilder from 'aws-cdk-lib/aws-amplifyuibuilder';
// amplifyuibuilder.CfnComponent

Properties

Configuration passed to the constructor as CfnComponentProps.

appIdOptional
string

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

bindingPropertiesOptional
IResolvable | { [key: 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` .

childrenOptional
IResolvable | IResolvable | ComponentChildProperty[]

A list of the component's `ComponentChild` instances.

collectionPropertiesOptional
IResolvable | { [key: string]: IResolvable | ComponentDataConfigurationProperty }

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` .

componentTypeOptional
string

The type of the component. This can be an Amplify custom UI component or another custom component.

environmentNameOptional
string

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

eventsOptional
IResolvable | { [key: string]: IResolvable | ComponentEventProperty }

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.

nameOptional
string

The name of the component.

overridesOptional
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` .

propertiesOptional
IResolvable | { [key: string]: IResolvable | ComponentPropertyProperty }

Describes the component's properties. You can't specify `tags` as a valid property for `properties` .

schemaVersionOptional
string

The schema version of the component when it was imported.

sourceIdOptional
string

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

tagsOptional
{ [key: string]: string }

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

variantsOptional
IResolvable | IResolvable | ComponentVariantProperty[]

A list of the component's variants. A variant is a unique style configuration of a main component.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::AmplifyUIBuilder::ComponentView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-amplifyuibuilder
CFN TypeAWS::AmplifyUIBuilder::Component
Properties14

Related Constructs

Explore This Service

External Links