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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentdataconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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 Details

getModel

@Stability(Stable)
@NotNull
String getModel()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentdataconfiguration.html#cfn-amplifyuibuilder-component-componentdataconfiguration-model

getIdentifiers

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentdataconfiguration.html#cfn-amplifyuibuilder-component-componentdataconfiguration-identifiers

getPredicate

@Stability(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.

Returns union: either IResolvable or CfnComponent.PredicateProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentdataconfiguration.html#cfn-amplifyuibuilder-component-componentdataconfiguration-predicate

getSort

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

Describes how to sort the component's properties.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnComponent.SortPropertyProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentdataconfiguration.html#cfn-amplifyuibuilder-component-componentdataconfiguration-sort

builder

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

Returns:

a CfnComponent.ComponentDataConfigurationProperty.Builder of CfnComponent.ComponentDataConfigurationProperty