software.amazon.awscdk.services.amplifyuibuilder

Interface CfnComponent.ComponentDataConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnComponent.ComponentDataConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnComponent

@Stability(value=Stable)
public static interface CfnComponent.ComponentDataConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 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")
                 .operator("operator")
                 .or(List.of(predicateProperty_))
                 .build())
         .sort(List.of(SortPropertyProperty.builder()
                 .direction("direction")
                 .field("field")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnComponent.ComponentDataConfigurationProperty.Builder A builder for CfnComponent.ComponentDataConfigurationProperty
static class	CfnComponent.ComponentDataConfigurationProperty.Jsii$Proxy An implementation for CfnComponent.ComponentDataConfigurationProperty

Method Summary

Modifier and Type	Method and Description
static CfnComponent.ComponentDataConfigurationProperty.Builder	builder()
default List<String>	getIdentifiers() A list of IDs to use to bind data to a component.
String	getModel() The name of the data model to use to bind data to a component.
default Object	getPredicate() Represents the conditional logic to use when binding data to a component.
default Object	getSort() Describes how to sort the component's properties.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getModel

@Stability(value=Stable)
 @NotNull
String getModel()

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

getIdentifiers

@Stability(value=Stable)
 @Nullable
default List<String> getIdentifiers()

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.

getPredicate

@Stability(value=Stable)
 @Nullable
default Object getPredicate()

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.

getSort

@Stability(value=Stable)
 @Nullable
default Object getSort()

Describes how to sort the component's properties.

builder

@Stability(value=Stable)
static CfnComponent.ComponentDataConfigurationProperty.Builder builder()

Returns:

a CfnComponent.ComponentDataConfigurationProperty.Builder of CfnComponent.ComponentDataConfigurationProperty