Skip to content
v2.277.0

PredicateProperty Struct ​

The Predicate property specifies information for generating Amplify DataStore queries.

Use Predicate to retrieve a subset of the data in a collection.

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 predicateProperty: amplifyuibuilder.CfnComponent.PredicateProperty = {
  and: [predicateProperty_],
  field: 'field',
  operand: 'operand',
  operandType: 'operandType',
  operator: 'operator',
  or: [predicateProperty_],
};
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

predicate_property = amplifyuibuilder.CfnComponent.PredicateProperty(
    and=[predicate_property_],
    field="field",
    operand="operand",
    operand_type="operandType",
    operator="operator",
    or=[predicate_property_]
)
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_;

PredicateProperty predicateProperty = PredicateProperty.builder()
        .and(List.of(predicateProperty_))
        .field("field")
        .operand("operand")
        .operandType("operandType")
        .operator("operator")
        .or(List.of(predicateProperty_))
        .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 predicateProperty = new PredicateProperty {
    And = new [] { predicateProperty_ },
    Field = "field",
    Operand = "operand",
    OperandType = "operandType",
    Operator = "operator",
    Or = new [] { predicateProperty_ }
};
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

predicateProperty := &PredicateProperty{
	And: []interface{}{
		predicateProperty_,
	},
	Field: jsii.String("field"),
	Operand: jsii.String("operand"),
	OperandType: jsii.String("operandType"),
	Operator: jsii.String("operator"),
	Or: []interface{}{
		predicateProperty_,
	},
}

Properties ​

andoptionalIResolvable | IResolvable | CfnComponent.PredicateProperty[]andoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PredicateProperty]]]andoptionalIResolvableAndoptionalIResolvableAndoptionalinterface{}#
A list of predicates to combine logically.
fieldoptionalstringfieldoptionalstrfieldoptionalStringFieldoptionalstringFieldoptional*string#
The field to query.
operandoptionalstringoperandoptionalstroperandoptionalStringOperandoptionalstringOperandoptional*string#
The value to use when performing the evaluation.
operandTypeoptionalstringoperand_typeoptionalstroperandTypeoptionalStringOperandTypeoptionalstringOperandTypeoptional*string#
The type of value to use when performing the evaluation.
operatoroptionalstringoperatoroptionalstroperatoroptionalStringOperatoroptionalstringOperatoroptional*string#
The operator to use to perform the evaluation.
oroptionalIResolvable | IResolvable | CfnComponent.PredicateProperty[]oroptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PredicateProperty]]]oroptionalIResolvableOroptionalIResolvableOroptionalinterface{}#
A list of predicates to combine logically.