interface ComponentDataConfigurationProperty

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

The ComponentDataConfiguration property specifies the configuration for binding a component's properties to data.

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 predicateProperty_: amplifyuibuilder.CfnComponent.PredicateProperty;
const componentDataConfigurationProperty: amplifyuibuilder.CfnComponent.ComponentDataConfigurationProperty = {
  model: 'model',

  // the properties below are optional
  identifiers: ['identifiers'],
  predicate: {
    and: [predicateProperty_],
    field: 'field',
    operand: 'operand',
    operandType: 'operandType',
    operator: 'operator',
    or: [predicateProperty_],
  },
  sort: [{
    direction: 'direction',
    field: 'field',
  }],
};

Properties

Name	Type	Description
model	`string`	The name of the data model to use to bind data to a component.
identifiers?	`string[]`	A list of IDs to use to bind data to a component.
predicate?	`IResolvable` `\|` `PredicateProperty`	Represents the conditional logic to use when binding data to a component.
sort?	`IResolvable` `\| (IResolvable` `\|` `SortPropertyProperty)[]`	Describes how to sort the component's properties.

model

Type: string

The name of the data model to use to bind data to a component.

identifiers?

Type: string[] (optional)

A list of IDs to use to bind data to a component.

Use this property to bind specifically chosen data, rather than data retrieved from a query.

predicate?

Type: IResolvable | PredicateProperty (optional)

Represents the conditional logic to use when binding data to a component.

Use this property to retrieve only a subset of the data in a collection.

sort?

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

Describes how to sort the component's properties.