Skip to content
v2.278.0

ComponentDataConfigurationProperty Struct ​

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

Example ​

ts
// 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',
  }],
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_amplifyuibuilder as amplifyuibuilder

# predicate_property_: amplifyuibuilder.CfnComponent.PredicateProperty

component_data_configuration_property = amplifyuibuilder.CfnComponent.ComponentDataConfigurationProperty(
    model="model",

    # the properties below are optional
    identifiers=["identifiers"],
    predicate=amplifyuibuilder.CfnComponent.PredicateProperty(
        and=[predicate_property_],
        field="field",
        operand="operand",
        operand_type="operandType",
        operator="operator",
        or=[predicate_property_]
    ),
    sort=[amplifyuibuilder.CfnComponent.SortPropertyProperty(
        direction="direction",
        field="field"
    )]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.amplifyuibuilder.*;

PredicateProperty predicateProperty_;

ComponentDataConfigurationProperty componentDataConfigurationProperty = ComponentDataConfigurationProperty.builder()
        .model("model")

        // the properties below are optional
        .identifiers(List.of("identifiers"))
        .predicate(PredicateProperty.builder()
                .and(List.of(predicateProperty_))
                .field("field")
                .operand("operand")
                .operandType("operandType")
                .operator("operator")
                .or(List.of(predicateProperty_))
                .build())
        .sort(List.of(SortPropertyProperty.builder()
                .direction("direction")
                .field("field")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AmplifyUIBuilder;

PredicateProperty predicateProperty_;

var componentDataConfigurationProperty = new ComponentDataConfigurationProperty {
    Model = "model",

    // the properties below are optional
    Identifiers = new [] { "identifiers" },
    Predicate = new PredicateProperty {
        And = new [] { predicateProperty_ },
        Field = "field",
        Operand = "operand",
        OperandType = "operandType",
        Operator = "operator",
        Or = new [] { predicateProperty_ }
    },
    Sort = new [] { new SortPropertyProperty {
        Direction = "direction",
        Field = "field"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var predicateProperty_ PredicateProperty

componentDataConfigurationProperty := &ComponentDataConfigurationProperty{
	Model: jsii.String("model"),

	// the properties below are optional
	Identifiers: []*string{
		jsii.String("identifiers"),
	},
	Predicate: &PredicateProperty{
		And: []interface{}{
			predicateProperty_,
		},
		Field: jsii.String("field"),
		Operand: jsii.String("operand"),
		OperandType: jsii.String("operandType"),
		Operator: jsii.String("operator"),
		Or: []interface{}{
			predicateProperty_,
		},
	},
	Sort: []interface{}{
		&SortPropertyProperty{
			Direction: jsii.String("direction"),
			Field: jsii.String("field"),
		},
	},
}

Properties ​

identifiersoptionalstring[]identifiersoptionaltyping.List[str]identifiersoptionalList<String>Identifiersoptionalstring[]Identifiersoptional*[]*string #
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.

modelstringmodelstrmodelStringModelstringModel*string required #
The name of the data model to use to bind data to a component.
predicateoptionalIResolvable | CfnComponent.PredicatePropertypredicateoptionaltyping.Union[IResolvable, PredicateProperty]predicateoptionalIResolvablePredicateoptionalIResolvablePredicateoptionalinterface{} #
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.

sortoptionalIResolvable | IResolvable | CfnComponent.SortPropertyProperty[]sortoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SortPropertyProperty]]]sortoptionalIResolvableSortoptionalIResolvableSortoptionalinterface{} #
Describes how to sort the component's properties.