CfnComponentPropsMixin

class aws_cdk.mixins_preview.aws_amplifyuibuilder.mixins.CfnComponentPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::AmplifyUIBuilder::Component resource specifies a component within an Amplify app.

A component is a user interface (UI) element that you can customize. Use ComponentChild to configure an instance of a Component . A ComponentChild instance inherits the configuration of the main Component .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html

CloudformationResource:

AWS::AmplifyUIBuilder::Component

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

Create a mixin to apply properties to AWS::AmplifyUIBuilder::Component.

Parameters:

• props (Union[CfnComponentMixinProps, Dict[str, Any]]) – L1 properties to apply.

• strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['appId', 'bindingProperties', 'children', 'collectionProperties', 'componentType', 'environmentName', 'events', 'name', 'overrides', 'properties', 'schemaVersion', 'sourceId', 'tags', 'variants']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental

ActionParametersProperty

class CfnComponentPropsMixin.ActionParametersProperty(*, anchor=None, fields=None, global_=None, id=None, model=None, state=None, target=None, type=None, url=None)

Bases: object

Represents the event action configuration for an element of a Component or ComponentChild .

Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. ActionParameters defines the action that is performed when an event occurs on the component.

Parameters:

• anchor (Union[IResolvable, ComponentPropertyProperty, Dict[str, Any], None]) – The HTML anchor link to the location to open. Specify this value for a navigation action.

• fields (Union[IResolvable, Mapping[str, Union[IResolvable, ComponentPropertyProperty, Dict[str, Any]]], None]) – A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.

• global – Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

• id (Union[IResolvable, ComponentPropertyProperty, Dict[str, Any], None]) – The unique ID of the component that the ActionParameters apply to.

• model (Optional[str]) – The name of the data model. Use when the action performs an operation on an Amplify DataStore model.

• state (Union[IResolvable, MutationActionSetStateParameterProperty, Dict[str, Any], None]) – A key-value pair that specifies the state property name and its initial value.

• target (Union[IResolvable, ComponentPropertyProperty, Dict[str, Any], None]) – The element within the same component to modify when the action occurs.

• type (Union[IResolvable, ComponentPropertyProperty, Dict[str, Any], None]) – The type of navigation action. Valid values are url and anchor . This value is required for a navigation action.

• url (Union[IResolvable, ComponentPropertyProperty, Dict[str, Any], None]) – The URL to the location to open. Specify this value for a navigation action.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_amplifyuibuilder import mixins as amplifyuibuilder_mixins

# component_property_property_: amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty

action_parameters_property = amplifyuibuilder_mixins.CfnComponentPropsMixin.ActionParametersProperty(
    anchor=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
        binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
            field="field",
            property="property"
        ),
        bindings={
            "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                element="element",
                property="property"
            )
        },
        collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
            field="field",
            property="property"
        ),
        component_name="componentName",
        concat=[component_property_property_],
        condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
            else=component_property_property_,
            field="field",
            operand="operand",
            operand_type="operandType",
            operator="operator",
            property="property",
            then=component_property_property_
        ),
        configured=False,
        default_value="defaultValue",
        event="event",
        imported_value="importedValue",
        model="model",
        property="property",
        type="type",
        user_attribute="userAttribute",
        value="value"
    ),
    fields={
        "fields_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
            binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                field="field",
                property="property"
            ),
            bindings={
                "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                    element="element",
                    property="property"
                )
            },
            collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                field="field",
                property="property"
            ),
            component_name="componentName",
            concat=[component_property_property_],
            condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
                else=component_property_property_,
                field="field",
                operand="operand",
                operand_type="operandType",
                operator="operator",
                property="property",
                then=component_property_property_
            ),
            configured=False,
            default_value="defaultValue",
            event="event",
            imported_value="importedValue",
            model="model",
            property="property",
            type="type",
            user_attribute="userAttribute",
            value="value"
        )
    },
    global=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
        binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
            field="field",
            property="property"
        ),
        bindings={
            "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                element="element",
                property="property"
            )
        },
        collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
            field="field",
            property="property"
        ),
        component_name="componentName",
        concat=[component_property_property_],
        condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
            else=component_property_property_,
            field="field",
            operand="operand",
            operand_type="operandType",
            operator="operator",
            property="property",
            then=component_property_property_
        ),
        configured=False,
        default_value="defaultValue",
        event="event",
        imported_value="importedValue",
        model="model",
        property="property",
        type="type",
        user_attribute="userAttribute",
        value="value"
    ),
    id=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
        binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
            field="field",
            property="property"
        ),
        bindings={
            "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                element="element",
                property="property"
            )
        },
        collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
            field="field",
            property="property"
        ),
        component_name="componentName",
        concat=[component_property_property_],
        condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
            else=component_property_property_,
            field="field",
            operand="operand",
            operand_type="operandType",
            operator="operator",
            property="property",
            then=component_property_property_
        ),
        configured=False,
        default_value="defaultValue",
        event="event",
        imported_value="importedValue",
        model="model",
        property="property",
        type="type",
        user_attribute="userAttribute",
        value="value"
    ),
    model="model",
    state=amplifyuibuilder_mixins.CfnComponentPropsMixin.MutationActionSetStateParameterProperty(
        component_name="componentName",
        property="property",
        set=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
            binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                field="field",
                property="property"
            ),
            bindings={
                "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                    element="element",
                    property="property"
                )
            },
            collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                field="field",
                property="property"
            ),
            component_name="componentName",
            concat=[component_property_property_],
            condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
                else=component_property_property_,
                field="field",
                operand="operand",
                operand_type="operandType",
                operator="operator",
                property="property",
                then=component_property_property_
            ),
            configured=False,
            default_value="defaultValue",
            event="event",
            imported_value="importedValue",
            model="model",
            property="property",
            type="type",
            user_attribute="userAttribute",
            value="value"
        )
    ),
    target=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
        binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
            field="field",
            property="property"
        ),
        bindings={
            "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                element="element",
                property="property"
            )
        },
        collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
            field="field",
            property="property"
        ),
        component_name="componentName",
        concat=[component_property_property_],
        condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
            else=component_property_property_,
            field="field",
            operand="operand",
            operand_type="operandType",
            operator="operator",
            property="property",
            then=component_property_property_
        ),
        configured=False,
        default_value="defaultValue",
        event="event",
        imported_value="importedValue",
        model="model",
        property="property",
        type="type",
        user_attribute="userAttribute",
        value="value"
    ),
    type=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
        binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
            field="field",
            property="property"
        ),
        bindings={
            "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                element="element",
                property="property"
            )
        },
        collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
            field="field",
            property="property"
        ),
        component_name="componentName",
        concat=[component_property_property_],
        condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
            else=component_property_property_,
            field="field",
            operand="operand",
            operand_type="operandType",
            operator="operator",
            property="property",
            then=component_property_property_
        ),
        configured=False,
        default_value="defaultValue",
        event="event",
        imported_value="importedValue",
        model="model",
        property="property",
        type="type",
        user_attribute="userAttribute",
        value="value"
    ),
    url=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
        binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
            field="field",
            property="property"
        ),
        bindings={
            "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                element="element",
                property="property"
            )
        },
        collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
            field="field",
            property="property"
        ),
        component_name="componentName",
        concat=[component_property_property_],
        condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
            else=component_property_property_,
            field="field",
            operand="operand",
            operand_type="operandType",
            operator="operator",
            property="property",
            then=component_property_property_
        ),
        configured=False,
        default_value="defaultValue",
        event="event",
        imported_value="importedValue",
        model="model",
        property="property",
        type="type",
        user_attribute="userAttribute",
        value="value"
    )
)

Attributes

anchor

The HTML anchor link to the location to open.

Specify this value for a navigation action.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-anchor

fields

A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model.

Use when the action performs an operation on an Amplify DataStore model.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-fields

global_

Specifies whether the user should be signed out globally.

Specify this value for an auth sign out action.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-global

id

The unique ID of the component that the ActionParameters apply to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-id

model

The name of the data model.

Use when the action performs an operation on an Amplify DataStore model.

See:

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

state

A key-value pair that specifies the state property name and its initial value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-state

target

The element within the same component to modify when the action occurs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-target

type

The type of navigation action.

Valid values are url and anchor . This value is required for a navigation action.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-type

url

The URL to the location to open.

Specify this value for a navigation action.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-url

ComponentBindingPropertiesValuePropertiesProperty

class CfnComponentPropsMixin.ComponentBindingPropertiesValuePropertiesProperty(*, bucket=None, default_value=None, field=None, key=None, model=None, predicates=None, slot_name=None, user_attribute=None)

Bases: object

The ComponentBindingPropertiesValueProperties property specifies the data binding configuration for a specific property using data stored in AWS .

For AWS connected properties, you can bind a property to data stored in an Amazon S3 bucket, an Amplify DataStore model or an authenticated user attribute.

Parameters:

• bucket (Optional[str]) – An Amazon S3 bucket.

• default_value (Optional[str]) – The default value to assign to the property.

• field (Optional[str]) – The field to bind the data to.

• key (Optional[str]) – The storage key for an Amazon S3 bucket.

• model (Optional[str]) – An Amplify DataStore model.

• predicates (Union[IResolvable, Sequence[Union[IResolvable, PredicateProperty, Dict[str, Any]]], None]) – A list of predicates for binding a component’s properties to data.

• slot_name (Optional[str]) – The name of a component slot.

• user_attribute (Optional[str]) – An authenticated user attribute.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_amplifyuibuilder import mixins as amplifyuibuilder_mixins

# predicate_property_: amplifyuibuilder_mixins.CfnComponentPropsMixin.PredicateProperty

component_binding_properties_value_properties_property = amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentBindingPropertiesValuePropertiesProperty(
    bucket="bucket",
    default_value="defaultValue",
    field="field",
    key="key",
    model="model",
    predicates=[amplifyuibuilder_mixins.CfnComponentPropsMixin.PredicateProperty(
        and=[predicate_property_],
        field="field",
        operand="operand",
        operand_type="operandType",
        operator="operator",
        or=[predicate_property_]
    )],
    slot_name="slotName",
    user_attribute="userAttribute"
)

Attributes

bucket

An Amazon S3 bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalueproperties.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalueproperties-bucket

default_value

The default value to assign to the property.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalueproperties.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalueproperties-defaultvalue

field

The field to bind the data to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalueproperties.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalueproperties-field

key

The storage key for an Amazon S3 bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalueproperties.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalueproperties-key

model

An Amplify DataStore model.

See:

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

predicates

A list of predicates for binding a component’s properties to data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalueproperties.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalueproperties-predicates

slot_name

The name of a component slot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalueproperties.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalueproperties-slotname

user_attribute

An authenticated user attribute.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalueproperties.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalueproperties-userattribute

ComponentBindingPropertiesValueProperty

class CfnComponentPropsMixin.ComponentBindingPropertiesValueProperty(*, binding_properties=None, default_value=None, type=None)

Bases: object

The ComponentBindingPropertiesValue property specifies the data binding configuration for a component at runtime.

You can use ComponentBindingPropertiesValue to add exposed properties to a component to allow different values to be entered when a component is reused in different places in an app.

Parameters:

• binding_properties (Union[IResolvable, ComponentBindingPropertiesValuePropertiesProperty, Dict[str, Any], None]) – Describes the properties to customize with data at runtime.

• default_value (Optional[str]) – The default value of the property.

• type (Optional[str]) – The property type.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_amplifyuibuilder import mixins as amplifyuibuilder_mixins

# predicate_property_: amplifyuibuilder_mixins.CfnComponentPropsMixin.PredicateProperty

component_binding_properties_value_property = amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentBindingPropertiesValueProperty(
    binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentBindingPropertiesValuePropertiesProperty(
        bucket="bucket",
        default_value="defaultValue",
        field="field",
        key="key",
        model="model",
        predicates=[amplifyuibuilder_mixins.CfnComponentPropsMixin.PredicateProperty(
            and=[predicate_property_],
            field="field",
            operand="operand",
            operand_type="operandType",
            operator="operator",
            or=[predicate_property_]
        )],
        slot_name="slotName",
        user_attribute="userAttribute"
    ),
    default_value="defaultValue",
    type="type"
)

Attributes

binding_properties

Describes the properties to customize with data at runtime.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalue.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalue-bindingproperties

default_value

The default value of the property.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalue.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalue-defaultvalue

type

The property type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalue.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalue-type

ComponentChildProperty

class CfnComponentPropsMixin.ComponentChildProperty(*, children=None, component_type=None, events=None, name=None, properties=None, source_id=None)

Bases: object

The ComponentChild property specifies a nested UI configuration within a parent Component .

Parameters:

• children (Union[IResolvable, Sequence[Union[IResolvable, ComponentChildProperty, Dict[str, Any]]], None]) – The list of ComponentChild instances for this component.

• component_type (Optional[str]) – The type of the child component.

• events (Union[IResolvable, Mapping[str, Union[IResolvable, ComponentEventProperty, Dict[str, Any]]], None]) – Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

• name (Optional[str]) – The name of the child component.

• properties (Union[IResolvable, Mapping[str, Union[IResolvable, ComponentPropertyProperty, Dict[str, Any]]], None]) – Describes the properties of the child component. You can’t specify tags as a valid property for properties .

• source_id (Optional[str]) – The unique ID of the child component in its original source system, such as Figma.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_amplifyuibuilder import mixins as amplifyuibuilder_mixins

# component_child_property_: amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentChildProperty
# component_property_property_: amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty

component_child_property = amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentChildProperty(
    children=[component_child_property_],
    component_type="componentType",
    events={
        "events_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentEventProperty(
            action="action",
            binding_event="bindingEvent",
            parameters=amplifyuibuilder_mixins.CfnComponentPropsMixin.ActionParametersProperty(
                anchor=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
                    binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                        field="field",
                        property="property"
                    ),
                    bindings={
                        "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                            element="element",
                            property="property"
                        )
                    },
                    collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                        field="field",
                        property="property"
                    ),
                    component_name="componentName",
                    concat=[component_property_property_],
                    condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
                        else=component_property_property_,
                        field="field",
                        operand="operand",
                        operand_type="operandType",
                        operator="operator",
                        property="property",
                        then=component_property_property_
                    ),
                    configured=False,
                    default_value="defaultValue",
                    event="event",
                    imported_value="importedValue",
                    model="model",
                    property="property",
                    type="type",
                    user_attribute="userAttribute",
                    value="value"
                ),
                fields={
                    "fields_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
                        binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                            field="field",
                            property="property"
                        ),
                        bindings={
                            "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                                element="element",
                                property="property"
                            )
                        },
                        collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                            field="field",
                            property="property"
                        ),
                        component_name="componentName",
                        concat=[component_property_property_],
                        condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
                            else=component_property_property_,
                            field="field",
                            operand="operand",
                            operand_type="operandType",
                            operator="operator",
                            property="property",
                            then=component_property_property_
                        ),
                        configured=False,
                        default_value="defaultValue",
                        event="event",
                        imported_value="importedValue",
                        model="model",
                        property="property",
                        type="type",
                        user_attribute="userAttribute",
                        value="value"
                    )
                },
                global=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
                    binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                        field="field",
                        property="property"
                    ),
                    bindings={
                        "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                            element="element",
                            property="property"
                        )
                    },
                    collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                        field="field",
                        property="property"
                    ),
                    component_name="componentName",
                    concat=[component_property_property_],
                    condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
                        else=component_property_property_,
                        field="field",
                        operand="operand",
                        operand_type="operandType",
                        operator="operator",
                        property="property",
                        then=component_property_property_
                    ),
                    configured=False,
                    default_value="defaultValue",
                    event="event",
                    imported_value="importedValue",
                    model="model",
                    property="property",
                    type="type",
                    user_attribute="userAttribute",
                    value="value"
                ),
                id=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
                    binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                        field="field",
                        property="property"
                    ),
                    bindings={
                        "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                            element="element",
                            property="property"
                        )
                    },
                    collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                        field="field",
                        property="property"
                    ),
                    component_name="componentName",
                    concat=[component_property_property_],
                    condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
                        else=component_property_property_,
                        field="field",
                        operand="operand",
                        operand_type="operandType",
                        operator="operator",
                        property="property",
                        then=component_property_property_
                    ),
                    configured=False,
                    default_value="defaultValue",
                    event="event",
                    imported_value="importedValue",
                    model="model",
                    property="property",
                    type="type",
                    user_attribute="userAttribute",
                    value="value"
                ),
                model="model",
                state=amplifyuibuilder_mixins.CfnComponentPropsMixin.MutationActionSetStateParameterProperty(
                    component_name="componentName",
                    property="property",
                    set=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
                        binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                            field="field",
                            property="property"
                        ),
                        bindings={
                            "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                                element="element",
                                property="property"
                            )
                        },
                        collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                            field="field",
                            property="property"
                        ),
                        component_name="componentName",
                        concat=[component_property_property_],
                        condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
                            else=component_property_property_,
                            field="field",
                            operand="operand",
                            operand_type="operandType",
                            operator="operator",
                            property="property",
                            then=component_property_property_
                        ),
                        configured=False,
                        default_value="defaultValue",
                        event="event",
                        imported_value="importedValue",
                        model="model",
                        property="property",
                        type="type",
                        user_attribute="userAttribute",
                        value="value"
                    )
                ),
                target=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
                    binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                        field="field",
                        property="property"
                    ),
                    bindings={
                        "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                            element="element",
                            property="property"
                        )
                    },
                    collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                        field="field",
                        property="property"
                    ),
                    component_name="componentName",
                    concat=[component_property_property_],
                    condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
                        else=component_property_property_,
                        field="field",
                        operand="operand",
                        operand_type="operandType",
                        operator="operator",
                        property="property",
                        then=component_property_property_
                    ),
                    configured=False,
                    default_value="defaultValue",
                    event="event",
                    imported_value="importedValue",
                    model="model",
                    property="property",
                    type="type",
                    user_attribute="userAttribute",
                    value="value"
                ),
                type=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
                    binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                        field="field",
                        property="property"
                    ),
                    bindings={
                        "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                            element="element",
                            property="property"
                        )
                    },
                    collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                        field="field",
                        property="property"
                    ),
                    component_name="componentName",
                    concat=[component_property_property_],
                    condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
                        else=component_property_property_,
                        field="field",
                        operand="operand",
                        operand_type="operandType",
                        operator="operator",
                        property="property",
                        then=component_property_property_
                    ),
                    configured=False,
                    default_value="defaultValue",
                    event="event",
                    imported_value="importedValue",
                    model="model",
                    property="property",
                    type="type",
                    user_attribute="userAttribute",
                    value="value"
                ),
                url=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
                    binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                        field="field",
                        property="property"
                    ),
                    bindings={
                        "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                            element="element",
                            property="property"
                        )
                    },
                    collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                        field="field",
                        property="property"
                    ),
                    component_name="componentName",
                    concat=[component_property_property_],
                    condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
                        else=component_property_property_,
                        field="field",
                        operand="operand",
                        operand_type="operandType",
                        operator="operator",
                        property="property",
                        then=component_property_property_
                    ),
                    configured=False,
                    default_value="defaultValue",
                    event="event",
                    imported_value="importedValue",
                    model="model",
                    property="property",
                    type="type",
                    user_attribute="userAttribute",
                    value="value"
                )
            )
        )
    },
    name="name",
    properties={
        "properties_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
            binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                field="field",
                property="property"
            ),
            bindings={
                "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                    element="element",
                    property="property"
                )
            },
            collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                field="field",
                property="property"
            ),
            component_name="componentName",
            concat=[component_property_property_],
            condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
                else=component_property_property_,
                field="field",
                operand="operand",
                operand_type="operandType",
                operator="operator",
                property="property",
                then=component_property_property_
            ),
            configured=False,
            default_value="defaultValue",
            event="event",
            imported_value="importedValue",
            model="model",
            property="property",
            type="type",
            user_attribute="userAttribute",
            value="value"
        )
    },
    source_id="sourceId"
)

Attributes

children

The list of ComponentChild instances for this component.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentchild.html#cfn-amplifyuibuilder-component-componentchild-children

component_type

The type of the child component.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentchild.html#cfn-amplifyuibuilder-component-componentchild-componenttype

events

Describes the events that can be raised on the child component.

Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentchild.html#cfn-amplifyuibuilder-component-componentchild-events

name

The name of the child component.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentchild.html#cfn-amplifyuibuilder-component-componentchild-name

properties

Describes the properties of the child component.

You can’t specify tags as a valid property for properties .

See:

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

source_id

The unique ID of the child component in its original source system, such as Figma.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentchild.html#cfn-amplifyuibuilder-component-componentchild-sourceid

ComponentConditionPropertyProperty

class CfnComponentPropsMixin.ComponentConditionPropertyProperty(*, else_=None, field=None, operand=None, operand_type=None, operator=None, property=None, then=None)

Bases: object

The ComponentConditionProperty property specifies a conditional expression for setting a component property.

Use ComponentConditionProperty to set a property to different values conditionally, based on the value of another property.

Parameters:

• else – The value to assign to the property if the condition is not met.

• field (Optional[str]) – The name of a field. Specify this when the property is a data model.

• operand (Optional[str]) – The value of the property to evaluate.

• operand_type (Optional[str]) – The type of the property to evaluate.

• operator (Optional[str]) – The operator to use to perform the evaluation, such as eq to represent equals.

• property (Optional[str]) – The name of the conditional property.

• then (Union[IResolvable, ComponentPropertyProperty, Dict[str, Any], None]) – The value to assign to the property if the condition is met.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_amplifyuibuilder import mixins as amplifyuibuilder_mixins

# component_condition_property_property_: amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty
# component_property_property_: amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty

component_condition_property_property = amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
    else=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
        binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
            field="field",
            property="property"
        ),
        bindings={
            "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                element="element",
                property="property"
            )
        },
        collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
            field="field",
            property="property"
        ),
        component_name="componentName",
        concat=[component_property_property_],
        condition=component_condition_property_property_,
        configured=False,
        default_value="defaultValue",
        event="event",
        imported_value="importedValue",
        model="model",
        property="property",
        type="type",
        user_attribute="userAttribute",
        value="value"
    ),
    field="field",
    operand="operand",
    operand_type="operandType",
    operator="operator",
    property="property",
    then=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
        binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
            field="field",
            property="property"
        ),
        bindings={
            "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                element="element",
                property="property"
            )
        },
        collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
            field="field",
            property="property"
        ),
        component_name="componentName",
        concat=[component_property_property_],
        condition=component_condition_property_property_,
        configured=False,
        default_value="defaultValue",
        event="event",
        imported_value="importedValue",
        model="model",
        property="property",
        type="type",
        user_attribute="userAttribute",
        value="value"
    )
)

Attributes

else_

The value to assign to the property if the condition is not met.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentconditionproperty.html#cfn-amplifyuibuilder-component-componentconditionproperty-else

field

The name of a field.

Specify this when the property is a data model.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentconditionproperty.html#cfn-amplifyuibuilder-component-componentconditionproperty-field

operand

The value of the property to evaluate.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentconditionproperty.html#cfn-amplifyuibuilder-component-componentconditionproperty-operand

operand_type

The type of the property to evaluate.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentconditionproperty.html#cfn-amplifyuibuilder-component-componentconditionproperty-operandtype

operator

The operator to use to perform the evaluation, such as eq to represent equals.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentconditionproperty.html#cfn-amplifyuibuilder-component-componentconditionproperty-operator

property

The name of the conditional property.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentconditionproperty.html#cfn-amplifyuibuilder-component-componentconditionproperty-property

then

The value to assign to the property if the condition is met.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentconditionproperty.html#cfn-amplifyuibuilder-component-componentconditionproperty-then

ComponentDataConfigurationProperty

class CfnComponentPropsMixin.ComponentDataConfigurationProperty(*, identifiers=None, model=None, predicate=None, sort=None)

Bases: object

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

Parameters:

• identifiers (Optional[Sequence[str]]) – 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.

• model (Optional[str]) – The name of the data model to use to bind data to a component.

• predicate (Union[IResolvable, PredicateProperty, Dict[str, Any], None]) – 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 (Union[IResolvable, Sequence[Union[IResolvable, SortPropertyProperty, Dict[str, Any]]], None]) – Describes how to sort the component’s properties.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_amplifyuibuilder import mixins as amplifyuibuilder_mixins

# predicate_property_: amplifyuibuilder_mixins.CfnComponentPropsMixin.PredicateProperty

component_data_configuration_property = amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentDataConfigurationProperty(
    identifiers=["identifiers"],
    model="model",
    predicate=amplifyuibuilder_mixins.CfnComponentPropsMixin.PredicateProperty(
        and=[predicate_property_],
        field="field",
        operand="operand",
        operand_type="operandType",
        operator="operator",
        or=[predicate_property_]
    ),
    sort=[amplifyuibuilder_mixins.CfnComponentPropsMixin.SortPropertyProperty(
        direction="direction",
        field="field"
    )]
)

Attributes

identifiers

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:

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

model

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

See:

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

predicate

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.

See:

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

sort

Describes how to sort the component’s properties.

See:

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

ComponentEventProperty

class CfnComponentPropsMixin.ComponentEventProperty(*, action=None, binding_event=None, parameters=None)

Bases: object

The ComponentEvent property specifies the configuration of an event.

You can bind an event and a corresponding action to a Component or a ComponentChild . A button click is an example of an event.

Parameters:

• action (Optional[str]) – The action to perform when a specific event is raised.

• binding_event (Optional[str]) – Binds an event to an action on a component. When you specify a bindingEvent , the event is called when the action is performed.

• parameters (Union[IResolvable, ActionParametersProperty, Dict[str, Any], None]) – Describes information about the action.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_amplifyuibuilder import mixins as amplifyuibuilder_mixins

# component_property_property_: amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty

component_event_property = amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentEventProperty(
    action="action",
    binding_event="bindingEvent",
    parameters=amplifyuibuilder_mixins.CfnComponentPropsMixin.ActionParametersProperty(
        anchor=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
            binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                field="field",
                property="property"
            ),
            bindings={
                "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                    element="element",
                    property="property"
                )
            },
            collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                field="field",
                property="property"
            ),
            component_name="componentName",
            concat=[component_property_property_],
            condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
                else=component_property_property_,
                field="field",
                operand="operand",
                operand_type="operandType",
                operator="operator",
                property="property",
                then=component_property_property_
            ),
            configured=False,
            default_value="defaultValue",
            event="event",
            imported_value="importedValue",
            model="model",
            property="property",
            type="type",
            user_attribute="userAttribute",
            value="value"
        ),
        fields={
            "fields_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
                binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                    field="field",
                    property="property"
                ),
                bindings={
                    "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                        element="element",
                        property="property"
                    )
                },
                collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                    field="field",
                    property="property"
                ),
                component_name="componentName",
                concat=[component_property_property_],
                condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
                    else=component_property_property_,
                    field="field",
                    operand="operand",
                    operand_type="operandType",
                    operator="operator",
                    property="property",
                    then=component_property_property_
                ),
                configured=False,
                default_value="defaultValue",
                event="event",
                imported_value="importedValue",
                model="model",
                property="property",
                type="type",
                user_attribute="userAttribute",
                value="value"
            )
        },
        global=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
            binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                field="field",
                property="property"
            ),
            bindings={
                "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                    element="element",
                    property="property"
                )
            },
            collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                field="field",
                property="property"
            ),
            component_name="componentName",
            concat=[component_property_property_],
            condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
                else=component_property_property_,
                field="field",
                operand="operand",
                operand_type="operandType",
                operator="operator",
                property="property",
                then=component_property_property_
            ),
            configured=False,
            default_value="defaultValue",
            event="event",
            imported_value="importedValue",
            model="model",
            property="property",
            type="type",
            user_attribute="userAttribute",
            value="value"
        ),
        id=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
            binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                field="field",
                property="property"
            ),
            bindings={
                "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                    element="element",
                    property="property"
                )
            },
            collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                field="field",
                property="property"
            ),
            component_name="componentName",
            concat=[component_property_property_],
            condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
                else=component_property_property_,
                field="field",
                operand="operand",
                operand_type="operandType",
                operator="operator",
                property="property",
                then=component_property_property_
            ),
            configured=False,
            default_value="defaultValue",
            event="event",
            imported_value="importedValue",
            model="model",
            property="property",
            type="type",
            user_attribute="userAttribute",
            value="value"
        ),
        model="model",
        state=amplifyuibuilder_mixins.CfnComponentPropsMixin.MutationActionSetStateParameterProperty(
            component_name="componentName",
            property="property",
            set=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
                binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                    field="field",
                    property="property"
                ),
                bindings={
                    "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                        element="element",
                        property="property"
                    )
                },
                collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                    field="field",
                    property="property"
                ),
                component_name="componentName",
                concat=[component_property_property_],
                condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
                    else=component_property_property_,
                    field="field",
                    operand="operand",
                    operand_type="operandType",
                    operator="operator",
                    property="property",
                    then=component_property_property_
                ),
                configured=False,
                default_value="defaultValue",
                event="event",
                imported_value="importedValue",
                model="model",
                property="property",
                type="type",
                user_attribute="userAttribute",
                value="value"
            )
        ),
        target=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
            binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                field="field",
                property="property"
            ),
            bindings={
                "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                    element="element",
                    property="property"
                )
            },
            collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                field="field",
                property="property"
            ),
            component_name="componentName",
            concat=[component_property_property_],
            condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
                else=component_property_property_,
                field="field",
                operand="operand",
                operand_type="operandType",
                operator="operator",
                property="property",
                then=component_property_property_
            ),
            configured=False,
            default_value="defaultValue",
            event="event",
            imported_value="importedValue",
            model="model",
            property="property",
            type="type",
            user_attribute="userAttribute",
            value="value"
        ),
        type=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
            binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                field="field",
                property="property"
            ),
            bindings={
                "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                    element="element",
                    property="property"
                )
            },
            collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                field="field",
                property="property"
            ),
            component_name="componentName",
            concat=[component_property_property_],
            condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
                else=component_property_property_,
                field="field",
                operand="operand",
                operand_type="operandType",
                operator="operator",
                property="property",
                then=component_property_property_
            ),
            configured=False,
            default_value="defaultValue",
            event="event",
            imported_value="importedValue",
            model="model",
            property="property",
            type="type",
            user_attribute="userAttribute",
            value="value"
        ),
        url=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
            binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                field="field",
                property="property"
            ),
            bindings={
                "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                    element="element",
                    property="property"
                )
            },
            collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
                field="field",
                property="property"
            ),
            component_name="componentName",
            concat=[component_property_property_],
            condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
                else=component_property_property_,
                field="field",
                operand="operand",
                operand_type="operandType",
                operator="operator",
                property="property",
                then=component_property_property_
            ),
            configured=False,
            default_value="defaultValue",
            event="event",
            imported_value="importedValue",
            model="model",
            property="property",
            type="type",
            user_attribute="userAttribute",
            value="value"
        )
    )
)

Attributes

action

The action to perform when a specific event is raised.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentevent.html#cfn-amplifyuibuilder-component-componentevent-action

binding_event

Binds an event to an action on a component.

When you specify a bindingEvent , the event is called when the action is performed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentevent.html#cfn-amplifyuibuilder-component-componentevent-bindingevent

parameters

Describes information about the action.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentevent.html#cfn-amplifyuibuilder-component-componentevent-parameters

ComponentPropertyBindingPropertiesProperty

class CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(*, field=None, property=None)

Bases: object

The ComponentPropertyBindingProperties property specifies a component property to associate with a binding property.

This enables exposed properties on the top level component to propagate data to the component’s property values.

Parameters:

• field (Optional[str]) – The data field to bind the property to.

• property (Optional[str]) – The component property to bind to the data field.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_amplifyuibuilder import mixins as amplifyuibuilder_mixins

component_property_binding_properties_property = amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
    field="field",
    property="property"
)

Attributes

field

The data field to bind the property to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentpropertybindingproperties.html#cfn-amplifyuibuilder-component-componentpropertybindingproperties-field

property

The component property to bind to the data field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentpropertybindingproperties.html#cfn-amplifyuibuilder-component-componentpropertybindingproperties-property

ComponentPropertyProperty

class CfnComponentPropsMixin.ComponentPropertyProperty(*, binding_properties=None, bindings=None, collection_binding_properties=None, component_name=None, concat=None, condition=None, configured=None, default_value=None, event=None, imported_value=None, model=None, property=None, type=None, user_attribute=None, value=None)

Bases: object

The ComponentProperty property specifies the configuration for all of a component’s properties.

Use ComponentProperty to specify the values to render or bind by default.

Parameters:

• binding_properties (Union[IResolvable, ComponentPropertyBindingPropertiesProperty, Dict[str, Any], None]) – The information to bind the component property to data at runtime.

• bindings (Union[IResolvable, Mapping[str, Union[IResolvable, FormBindingElementProperty, Dict[str, Any]]], None]) – The information to bind the component property to form data.

• collection_binding_properties (Union[IResolvable, ComponentPropertyBindingPropertiesProperty, Dict[str, Any], None]) – The information to bind the component property to data at runtime. Use this for collection components.

• component_name (Optional[str]) – The name of the component that is affected by an event.

• concat (Union[IResolvable, Sequence[Union[IResolvable, ComponentPropertyProperty, Dict[str, Any]]], None]) – A list of component properties to concatenate to create the value to assign to this component property.

• condition (Union[IResolvable, ComponentConditionPropertyProperty, Dict[str, Any], None]) – The conditional expression to use to assign a value to the component property.

• configured (Union[bool, IResolvable, None]) – Specifies whether the user configured the property in Amplify Studio after importing it.

• default_value (Optional[str]) – The default value to assign to the component property.

• event (Optional[str]) – An event that occurs in your app. Use this for workflow data binding.

• imported_value (Optional[str]) – The default value assigned to the property when the component is imported into an app.

• model (Optional[str]) – The data model to use to assign a value to the component property.

• property (Optional[str]) – The name of the component’s property that is affected by an event.

• type (Optional[str]) – The component type.

• user_attribute (Optional[str]) – An authenticated user attribute to use to assign a value to the component property.

• value (Optional[str]) – The value to assign to the component property.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_amplifyuibuilder import mixins as amplifyuibuilder_mixins

# component_property_property_: amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty

component_property_property = amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
    binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
        field="field",
        property="property"
    ),
    bindings={
        "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
            element="element",
            property="property"
        )
    },
    collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
        field="field",
        property="property"
    ),
    component_name="componentName",
    concat=[component_property_property_],
    condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
        else=component_property_property_,
        field="field",
        operand="operand",
        operand_type="operandType",
        operator="operator",
        property="property",
        then=component_property_property_
    ),
    configured=False,
    default_value="defaultValue",
    event="event",
    imported_value="importedValue",
    model="model",
    property="property",
    type="type",
    user_attribute="userAttribute",
    value="value"
)

Attributes

binding_properties

The information to bind the component property to data at runtime.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-bindingproperties

bindings

The information to bind the component property to form data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-bindings

collection_binding_properties

The information to bind the component property to data at runtime.

Use this for collection components.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-collectionbindingproperties

component_name

The name of the component that is affected by an event.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-componentname

concat

A list of component properties to concatenate to create the value to assign to this component property.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-concat

condition

The conditional expression to use to assign a value to the component property.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-condition

configured

Specifies whether the user configured the property in Amplify Studio after importing it.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-configured

default_value

The default value to assign to the component property.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-defaultvalue

event

An event that occurs in your app.

Use this for workflow data binding.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-event

imported_value

The default value assigned to the property when the component is imported into an app.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-importedvalue

model

The data model to use to assign a value to the component property.

See:

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

property

The name of the component’s property that is affected by an event.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-property

type

The component type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-type

user_attribute

An authenticated user attribute to use to assign a value to the component property.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-userattribute

value

The value to assign to the component property.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-value

ComponentVariantProperty

class CfnComponentPropsMixin.ComponentVariantProperty(*, overrides=None, variant_values=None)

Bases: object

The ComponentVariant property specifies the style configuration of a unique variation of a main component.

Parameters:

• overrides (Any) – The properties of the component variant that can be overriden when customizing an instance of the component. You can’t specify tags as a valid property for overrides .

• variant_values (Union[Mapping[str, str], IResolvable, None]) – The combination of variants that comprise this variant.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_amplifyuibuilder import mixins as amplifyuibuilder_mixins

# overrides: Any

component_variant_property = amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentVariantProperty(
    overrides=overrides,
    variant_values={
        "variant_values_key": "variantValues"
    }
)

Attributes

overrides

The properties of the component variant that can be overriden when customizing an instance of the component.

You can’t specify tags as a valid property for overrides .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentvariant.html#cfn-amplifyuibuilder-component-componentvariant-overrides

variant_values

The combination of variants that comprise this variant.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentvariant.html#cfn-amplifyuibuilder-component-componentvariant-variantvalues

FormBindingElementProperty

class CfnComponentPropsMixin.FormBindingElementProperty(*, element=None, property=None)

Bases: object

Describes how to bind a component property to form data.

Parameters:

• element (Optional[str]) – The name of the component to retrieve a value from.

• property (Optional[str]) – The property to retrieve a value from.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_amplifyuibuilder import mixins as amplifyuibuilder_mixins

form_binding_element_property = amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
    element="element",
    property="property"
)

Attributes

element

The name of the component to retrieve a value from.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-formbindingelement.html#cfn-amplifyuibuilder-component-formbindingelement-element

property

The property to retrieve a value from.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-formbindingelement.html#cfn-amplifyuibuilder-component-formbindingelement-property

MutationActionSetStateParameterProperty

class CfnComponentPropsMixin.MutationActionSetStateParameterProperty(*, component_name=None, property=None, set=None)

Bases: object

Represents the state configuration when an action modifies a property of another element within the same component.

Parameters:

• component_name (Optional[str]) – The name of the component that is being modified.

• property (Optional[str]) – The name of the component property to apply the state configuration to.

• set (Union[IResolvable, ComponentPropertyProperty, Dict[str, Any], None]) – The state configuration to assign to the property.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_amplifyuibuilder import mixins as amplifyuibuilder_mixins

# component_property_property_: amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty

mutation_action_set_state_parameter_property = amplifyuibuilder_mixins.CfnComponentPropsMixin.MutationActionSetStateParameterProperty(
    component_name="componentName",
    property="property",
    set=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyProperty(
        binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
            field="field",
            property="property"
        ),
        bindings={
            "bindings_key": amplifyuibuilder_mixins.CfnComponentPropsMixin.FormBindingElementProperty(
                element="element",
                property="property"
            )
        },
        collection_binding_properties=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentPropertyBindingPropertiesProperty(
            field="field",
            property="property"
        ),
        component_name="componentName",
        concat=[component_property_property_],
        condition=amplifyuibuilder_mixins.CfnComponentPropsMixin.ComponentConditionPropertyProperty(
            else=component_property_property_,
            field="field",
            operand="operand",
            operand_type="operandType",
            operator="operator",
            property="property",
            then=component_property_property_
        ),
        configured=False,
        default_value="defaultValue",
        event="event",
        imported_value="importedValue",
        model="model",
        property="property",
        type="type",
        user_attribute="userAttribute",
        value="value"
    )
)

Attributes

component_name

The name of the component that is being modified.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-mutationactionsetstateparameter.html#cfn-amplifyuibuilder-component-mutationactionsetstateparameter-componentname

property

The name of the component property to apply the state configuration to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-mutationactionsetstateparameter.html#cfn-amplifyuibuilder-component-mutationactionsetstateparameter-property

set

The state configuration to assign to the property.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-mutationactionsetstateparameter.html#cfn-amplifyuibuilder-component-mutationactionsetstateparameter-set

PredicateProperty

class CfnComponentPropsMixin.PredicateProperty(*, and_=None, field=None, operand=None, operand_type=None, operator=None, or_=None)

Bases: object

The Predicate property specifies information for generating Amplify DataStore queries.

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

Parameters:

• and – A list of predicates to combine logically.

• field (Optional[str]) – The field to query.

• operand (Optional[str]) – The value to use when performing the evaluation.

• operand_type (Optional[str]) – The type of value to use when performing the evaluation.

• operator (Optional[str]) – The operator to use to perform the evaluation.

• or – A list of predicates to combine logically.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_amplifyuibuilder import mixins as amplifyuibuilder_mixins

# predicate_property_: amplifyuibuilder_mixins.CfnComponentPropsMixin.PredicateProperty

predicate_property = amplifyuibuilder_mixins.CfnComponentPropsMixin.PredicateProperty(
    and=[predicate_property_],
    field="field",
    operand="operand",
    operand_type="operandType",
    operator="operator",
    or=[predicate_property_]
)

Attributes

and_

A list of predicates to combine logically.

See:

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

field

The field to query.

See:

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

operand

The value to use when performing the evaluation.

See:

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

operand_type

The type of value to use when performing the evaluation.

See:

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

operator

The operator to use to perform the evaluation.

See:

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

or_

A list of predicates to combine logically.

See:

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

SortPropertyProperty

class CfnComponentPropsMixin.SortPropertyProperty(*, direction=None, field=None)

Bases: object

The SortProperty property specifies how to sort the data that you bind to a component.

Parameters:

• direction (Optional[str]) – The direction of the sort, either ascending or descending.

• field (Optional[str]) – The field to perform the sort on.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_amplifyuibuilder import mixins as amplifyuibuilder_mixins

sort_property_property = amplifyuibuilder_mixins.CfnComponentPropsMixin.SortPropertyProperty(
    direction="direction",
    field="field"
)

Attributes

direction

The direction of the sort, either ascending or descending.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-sortproperty.html#cfn-amplifyuibuilder-component-sortproperty-direction

field

The field to perform the sort on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-sortproperty.html#cfn-amplifyuibuilder-component-sortproperty-field