AWS::AmplifyUIBuilder::Component

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::AmplifyUIBuilder::Component",
  "Properties" : {
      "AppId" : String,
      "BindingProperties" : {Key: Value, ...},
      "Children" : [ ComponentChild, ... ],
      "CollectionProperties" : {Key: Value, ...},
      "ComponentType" : String,
      "EnvironmentName" : String,
      "Events" : {Key: Value, ...},
      "Name" : String,
      "Overrides" : {Key: Value, ...},
      "Properties" : {Key: Value, ...},
      "SchemaVersion" : String,
      "SourceId" : String,
      "Tags" : {Key: Value, ...},
      "Variants" : [ ComponentVariant, ... ]
    }
}

YAML

Type: AWS::AmplifyUIBuilder::Component
Properties:
  AppId: String
  BindingProperties: 
    Key: Value
  Children: 
    - ComponentChild
  CollectionProperties: 
    Key: Value
  ComponentType: String
  EnvironmentName: String
  Events: 
    Key: Value
  Name: String
  Overrides: 
    Key: Value
  Properties: 
    Key: Value
  SchemaVersion: String
  SourceId: String
  Tags: 
    Key: Value
  Variants: 
    - ComponentVariant

Properties

AppId

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

Required: No

Type: String

Update requires: Replacement

BindingProperties

The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties.

Required: No

Type: Object of ComponentBindingPropertiesValue

Update requires: No interruption

Children

A list of the component's ComponentChild instances.

Required: No

Type: Array of ComponentChild

Update requires: No interruption

CollectionProperties

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.

Required: No

Type: Object of ComponentDataConfiguration

Update requires: No interruption

ComponentType

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

Required: No

Type: String

Minimum: 1

Maximum: 255

Update requires: No interruption

EnvironmentName

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

Required: No

Type: String

Update requires: Replacement

Events

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.

Required: No

Type: Object of ComponentEvent

Update requires: No interruption

Name

The name of the component.

Required: No

Type: String

Minimum: 1

Maximum: 255

Update requires: No interruption

Overrides

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.

Required: No

Type: Object of String

Pattern: .+

Update requires: No interruption

Properties

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

Required: No

Type: Object of ComponentProperty

Update requires: No interruption

SchemaVersion

The schema version of the component when it was imported.

Required: No

Type: String

Update requires: No interruption

SourceId

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

Required: No

Type: String

Update requires: No interruption

Tags

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

Required: No

Type: Object of String

Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Minimum: 1

Maximum: 256

Update requires: No interruption

Variants

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

Required: No

Type: Array of ComponentVariant

Update requires: No interruption

Return values

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CreatedAt

The time that the component was created.

Id

The unique ID of the component.

ModifiedAt

The time that the component was modified.