aws-cdk-lib.aws_amplifyuibuilder.CfnComponent.ComponentPropertyProperty

interface ComponentPropertyProperty

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

The ComponentProperty property specifies the configuration for all of a component's properties.

Use ComponentProperty to specify the values to render or bind by default.

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 componentConditionPropertyProperty_: amplifyuibuilder.CfnComponent.ComponentConditionPropertyProperty;
declare const componentPropertyProperty_: amplifyuibuilder.CfnComponent.ComponentPropertyProperty;
const componentPropertyProperty: amplifyuibuilder.CfnComponent.ComponentPropertyProperty = {
  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: [{
    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',
  }],
  condition: {
    else: {
      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: componentConditionPropertyProperty_,
      configured: false,
      defaultValue: 'defaultValue',
      event: 'event',
      importedValue: 'importedValue',
      model: 'model',
      property: 'property',
      type: 'type',
      userAttribute: 'userAttribute',
      value: 'value',
    },
    field: 'field',
    operand: 'operand',
    operandType: 'operandType',
    operator: 'operator',
    property: 'property',
    then: {
      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: componentConditionPropertyProperty_,
      configured: false,
      defaultValue: 'defaultValue',
      event: 'event',
      importedValue: 'importedValue',
      model: 'model',
      property: 'property',
      type: 'type',
      userAttribute: 'userAttribute',
      value: 'value',
    },
  },
  configured: false,
  defaultValue: 'defaultValue',
  event: 'event',
  importedValue: 'importedValue',
  model: 'model',
  property: 'property',
  type: 'type',
  userAttribute: 'userAttribute',
  value: 'value',
};

Properties

NameTypeDescription
bindingProperties?IResolvable | ComponentPropertyBindingPropertiesPropertyThe information to bind the component property to data at runtime.
bindings?IResolvable | { [string]: IResolvable | FormBindingElementProperty }The information to bind the component property to form data.
collectionBindingProperties?IResolvable | ComponentPropertyBindingPropertiesPropertyThe information to bind the component property to data at runtime.
componentName?stringThe name of the component that is affected by an event.
concat?IResolvable | IResolvable | ComponentPropertyProperty[]A list of component properties to concatenate to create the value to assign to this component property.
condition?IResolvable | ComponentConditionPropertyPropertyThe conditional expression to use to assign a value to the component property.
configured?boolean | IResolvableSpecifies whether the user configured the property in Amplify Studio after importing it.
defaultValue?stringThe default value to assign to the component property.
event?stringAn event that occurs in your app.
importedValue?stringThe default value assigned to the property when the component is imported into an app.
model?stringThe data model to use to assign a value to the component property.
property?stringThe name of the component's property that is affected by an event.
type?stringThe component type.
userAttribute?stringAn authenticated user attribute to use to assign a value to the component property.
value?stringThe value to assign to the component property.

bindingProperties?

Type: IResolvable | ComponentPropertyBindingPropertiesProperty (optional)

The information to bind the component property to data at runtime.


bindings?

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

The information to bind the component property to form data.


collectionBindingProperties?

Type: IResolvable | ComponentPropertyBindingPropertiesProperty (optional)

The information to bind the component property to data at runtime.

Use this for collection components.


componentName?

Type: string (optional)

The name of the component that is affected by an event.


concat?

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

A list of component properties to concatenate to create the value to assign to this component property.


condition?

Type: IResolvable | ComponentConditionPropertyProperty (optional)

The conditional expression to use to assign a value to the component property.


configured?

Type: boolean | IResolvable (optional)

Specifies whether the user configured the property in Amplify Studio after importing it.


defaultValue?

Type: string (optional)

The default value to assign to the component property.


event?

Type: string (optional)

An event that occurs in your app.

Use this for workflow data binding.


importedValue?

Type: string (optional)

The default value assigned to the property when the component is imported into an app.


model?

Type: string (optional)

The data model to use to assign a value to the component property.


property?

Type: string (optional)

The name of the component's property that is affected by an event.


type?

Type: string (optional)

The component type.


userAttribute?

Type: string (optional)

An authenticated user attribute to use to assign a value to the component property.


value?

Type: string (optional)

The value to assign to the component property.