interface ComponentChildProperty

Language	Type name
.NET	Amazon.CDK.AWS.AmplifyUIBuilder.CfnComponent.ComponentChildProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsamplifyuibuilder#CfnComponent_ComponentChildProperty
Java	software.amazon.awscdk.services.amplifyuibuilder.CfnComponent.ComponentChildProperty
Python	aws_cdk.aws_amplifyuibuilder.CfnComponent.ComponentChildProperty
TypeScript	aws-cdk-lib » aws_amplifyuibuilder » CfnComponent » ComponentChildProperty

The ComponentChild property specifies a nested UI configuration within a parent Component .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentchild.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_amplifyuibuilder as amplifyuibuilder } from 'aws-cdk-lib';

declare const componentChildProperty_: amplifyuibuilder.CfnComponent.ComponentChildProperty;
declare const componentPropertyProperty_: amplifyuibuilder.CfnComponent.ComponentPropertyProperty;
const componentChildProperty: amplifyuibuilder.CfnComponent.ComponentChildProperty = {
  componentType: 'componentType',
  name: 'name',
  properties: {
    propertiesKey: {
      bindingProperties: {
        property: 'property',

        // the properties below are optional
        field: 'field',
      },
      bindings: {
        bindingsKey: {
          element: 'element',
          property: 'property',
        },
      },
      collectionBindingProperties: {
        property: 'property',

        // the properties below are optional
        field: 'field',
      },
      componentName: 'componentName',
      concat: [componentPropertyProperty_],
      condition: {
        else: componentPropertyProperty_,
        field: 'field',
        operand: 'operand',
        operandType: 'operandType',
        operator: 'operator',
        property: 'property',
        then: componentPropertyProperty_,
      },
      configured: false,
      defaultValue: 'defaultValue',
      event: 'event',
      importedValue: 'importedValue',
      model: 'model',
      property: 'property',
      type: 'type',
      userAttribute: 'userAttribute',
      value: 'value',
    },
  },

  // the properties below are optional
  children: [componentChildProperty_],
  events: {
    eventsKey: {
      action: 'action',
      bindingEvent: 'bindingEvent',
      parameters: {
        anchor: {
          bindingProperties: {
            property: 'property',

            // the properties below are optional
            field: 'field',
          },
          bindings: {
            bindingsKey: {
              element: 'element',
              property: 'property',
            },
          },
          collectionBindingProperties: {
            property: 'property',

            // the properties below are optional
            field: 'field',
          },
          componentName: 'componentName',
          concat: [componentPropertyProperty_],
          condition: {
            else: componentPropertyProperty_,
            field: 'field',
            operand: 'operand',
            operandType: 'operandType',
            operator: 'operator',
            property: 'property',
            then: componentPropertyProperty_,
          },
          configured: false,
          defaultValue: 'defaultValue',
          event: 'event',
          importedValue: 'importedValue',
          model: 'model',
          property: 'property',
          type: 'type',
          userAttribute: 'userAttribute',
          value: 'value',
        },
        fields: {
          fieldsKey: {
            bindingProperties: {
              property: 'property',

              // the properties below are optional
              field: 'field',
            },
            bindings: {
              bindingsKey: {
                element: 'element',
                property: 'property',
              },
            },
            collectionBindingProperties: {
              property: 'property',

              // the properties below are optional
              field: 'field',
            },
            componentName: 'componentName',
            concat: [componentPropertyProperty_],
            condition: {
              else: componentPropertyProperty_,
              field: 'field',
              operand: 'operand',
              operandType: 'operandType',
              operator: 'operator',
              property: 'property',
              then: componentPropertyProperty_,
            },
            configured: false,
            defaultValue: 'defaultValue',
            event: 'event',
            importedValue: 'importedValue',
            model: 'model',
            property: 'property',
            type: 'type',
            userAttribute: 'userAttribute',
            value: 'value',
          },
        },
        global: {
          bindingProperties: {
            property: 'property',

            // the properties below are optional
            field: 'field',
          },
          bindings: {
            bindingsKey: {
              element: 'element',
              property: 'property',
            },
          },
          collectionBindingProperties: {
            property: 'property',

            // the properties below are optional
            field: 'field',
          },
          componentName: 'componentName',
          concat: [componentPropertyProperty_],
          condition: {
            else: componentPropertyProperty_,
            field: 'field',
            operand: 'operand',
            operandType: 'operandType',
            operator: 'operator',
            property: 'property',
            then: componentPropertyProperty_,
          },
          configured: false,
          defaultValue: 'defaultValue',
          event: 'event',
          importedValue: 'importedValue',
          model: 'model',
          property: 'property',
          type: 'type',
          userAttribute: 'userAttribute',
          value: 'value',
        },
        id: {
          bindingProperties: {
            property: 'property',

            // the properties below are optional
            field: 'field',
          },
          bindings: {
            bindingsKey: {
              element: 'element',
              property: 'property',
            },
          },
          collectionBindingProperties: {
            property: 'property',

            // the properties below are optional
            field: 'field',
          },
          componentName: 'componentName',
          concat: [componentPropertyProperty_],
          condition: {
            else: componentPropertyProperty_,
            field: 'field',
            operand: 'operand',
            operandType: 'operandType',
            operator: 'operator',
            property: 'property',
            then: componentPropertyProperty_,
          },
          configured: false,
          defaultValue: 'defaultValue',
          event: 'event',
          importedValue: 'importedValue',
          model: 'model',
          property: 'property',
          type: 'type',
          userAttribute: 'userAttribute',
          value: 'value',
        },
        model: 'model',
        state: {
          componentName: 'componentName',
          property: 'property',
          set: {
            bindingProperties: {
              property: 'property',

              // the properties below are optional
              field: 'field',
            },
            bindings: {
              bindingsKey: {
                element: 'element',
                property: 'property',
              },
            },
            collectionBindingProperties: {
              property: 'property',

              // the properties below are optional
              field: 'field',
            },
            componentName: 'componentName',
            concat: [componentPropertyProperty_],
            condition: {
              else: componentPropertyProperty_,
              field: 'field',
              operand: 'operand',
              operandType: 'operandType',
              operator: 'operator',
              property: 'property',
              then: componentPropertyProperty_,
            },
            configured: false,
            defaultValue: 'defaultValue',
            event: 'event',
            importedValue: 'importedValue',
            model: 'model',
            property: 'property',
            type: 'type',
            userAttribute: 'userAttribute',
            value: 'value',
          },
        },
        target: {
          bindingProperties: {
            property: 'property',

            // the properties below are optional
            field: 'field',
          },
          bindings: {
            bindingsKey: {
              element: 'element',
              property: 'property',
            },
          },
          collectionBindingProperties: {
            property: 'property',

            // the properties below are optional
            field: 'field',
          },
          componentName: 'componentName',
          concat: [componentPropertyProperty_],
          condition: {
            else: componentPropertyProperty_,
            field: 'field',
            operand: 'operand',
            operandType: 'operandType',
            operator: 'operator',
            property: 'property',
            then: componentPropertyProperty_,
          },
          configured: false,
          defaultValue: 'defaultValue',
          event: 'event',
          importedValue: 'importedValue',
          model: 'model',
          property: 'property',
          type: 'type',
          userAttribute: 'userAttribute',
          value: 'value',
        },
        type: {
          bindingProperties: {
            property: 'property',

            // the properties below are optional
            field: 'field',
          },
          bindings: {
            bindingsKey: {
              element: 'element',
              property: 'property',
            },
          },
          collectionBindingProperties: {
            property: 'property',

            // the properties below are optional
            field: 'field',
          },
          componentName: 'componentName',
          concat: [componentPropertyProperty_],
          condition: {
            else: componentPropertyProperty_,
            field: 'field',
            operand: 'operand',
            operandType: 'operandType',
            operator: 'operator',
            property: 'property',
            then: componentPropertyProperty_,
          },
          configured: false,
          defaultValue: 'defaultValue',
          event: 'event',
          importedValue: 'importedValue',
          model: 'model',
          property: 'property',
          type: 'type',
          userAttribute: 'userAttribute',
          value: 'value',
        },
        url: {
          bindingProperties: {
            property: 'property',

            // the properties below are optional
            field: 'field',
          },
          bindings: {
            bindingsKey: {
              element: 'element',
              property: 'property',
            },
          },
          collectionBindingProperties: {
            property: 'property',

            // the properties below are optional
            field: 'field',
          },
          componentName: 'componentName',
          concat: [componentPropertyProperty_],
          condition: {
            else: componentPropertyProperty_,
            field: 'field',
            operand: 'operand',
            operandType: 'operandType',
            operator: 'operator',
            property: 'property',
            then: componentPropertyProperty_,
          },
          configured: false,
          defaultValue: 'defaultValue',
          event: 'event',
          importedValue: 'importedValue',
          model: 'model',
          property: 'property',
          type: 'type',
          userAttribute: 'userAttribute',
          value: 'value',
        },
      },
    },
  },
  sourceId: 'sourceId',
};

Properties

Name	Type	Description
componentType	string	The type of the child component.
name	string	The name of the child component.
properties	IResolvable | { [string]: IResolvable | ComponentPropertyProperty }	Describes the properties of the child component.
children?	IResolvable | IResolvable | ComponentChildProperty[]	The list of ComponentChild instances for this component.
events?	IResolvable | { [string]: IResolvable | ComponentEventProperty }	Describes the events that can be raised on the child component.
sourceId?	string	The unique ID of the child component in its original source system, such as Figma.

---

componentType

Type: string

The type of the child component.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentchild.html#cfn-amplifyuibuilder-component-componentchild-componenttype

---

name

Type: string

The name of the child component.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentchild.html#cfn-amplifyuibuilder-component-componentchild-name

---

properties

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

Describes the properties of the child component.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentchild.html#cfn-amplifyuibuilder-component-componentchild-properties

---

children?

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

The list of ComponentChild instances for this component.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentchild.html#cfn-amplifyuibuilder-component-componentchild-children

---

events?

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

Describes the events that can be raised on the child component.

Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentchild.html#cfn-amplifyuibuilder-component-componentchild-events

---

sourceId?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentchild.html#cfn-amplifyuibuilder-component-componentchild-sourceid