CfnComponent
- class aws_cdk.aws_amplifyuibuilder.CfnComponent(scope, id, *, app_id=None, binding_properties=None, children=None, collection_properties=None, component_type=None, environment_name=None, events=None, name=None, overrides=None, properties=None, schema_version=None, source_id=None, tags=None, variants=None)
Bases:
CfnResource
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 aComponent
. AComponentChild
instance inherits the configuration of the mainComponent
.- See:
- CloudformationResource:
AWS::AmplifyUIBuilder::Component
- ExampleMetadata:
fixture=_generated
Example:
:type scope: :py:class:`~constructs.Construct` :param scope: Scope in which this resource is defined. :type id: :py:class:`str` :param id: Construct identifier for this resource (unique in its scope). :type app_id: :py:data:`~typing.Optional`\[:py:class:`str`] :param app_id: The unique ID of the Amplify app associated with the component. :type binding_properties: :py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~typing.Mapping`\[:py:class:`str`, :py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~aws_cdk.aws_amplifyuibuilder.CfnComponent.ComponentBindingPropertiesValueProperty`, :py:class:`~typing.Dict`\[:py:class:`str`, :py:data:`~typing.Any`]]], :py:obj:`None`] :param binding_properties: The information to connect a component's properties to data at runtime. You can't specify ``tags`` as a valid property for ``bindingProperties`` . :type children: :py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~typing.Sequence`\[:py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~aws_cdk.aws_amplifyuibuilder.CfnComponent.ComponentChildProperty`, :py:class:`~typing.Dict`\[:py:class:`str`, :py:data:`~typing.Any`]]], :py:obj:`None`] :param children: A list of the component's ``ComponentChild`` instances. :type collection_properties: :py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~typing.Mapping`\[:py:class:`str`, :py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~aws_cdk.aws_amplifyuibuilder.CfnComponent.ComponentDataConfigurationProperty`, :py:class:`~typing.Dict`\[:py:class:`str`, :py:data:`~typing.Any`]]], :py:obj:`None`] :param collection_properties: The data binding configuration for the component's properties. Use this for a collection component. You can't specify ``tags`` as a valid property for ``collectionProperties`` . :type component_type: :py:data:`~typing.Optional`\[:py:class:`str`] :param component_type: The type of the component. This can be an Amplify custom UI component or another custom component. :type environment_name: :py:data:`~typing.Optional`\[:py:class:`str`] :param environment_name: The name of the backend environment that is a part of the Amplify app. :type events: :py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~typing.Mapping`\[:py:class:`str`, :py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~aws_cdk.aws_amplifyuibuilder.CfnComponent.ComponentEventProperty`, :py:class:`~typing.Dict`\[:py:class:`str`, :py:data:`~typing.Any`]]], :py:obj:`None`] :param events: Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. :type name: :py:data:`~typing.Optional`\[:py:class:`str`] :param name: The name of the component. :type overrides: :py:data:`~typing.Any` :param overrides: Describes the component's properties that can be overriden in a customized instance of the component. You can't specify ``tags`` as a valid property for ``overrides`` . :type properties: :py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~typing.Mapping`\[:py:class:`str`, :py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~aws_cdk.aws_amplifyuibuilder.CfnComponent.ComponentPropertyProperty`, :py:class:`~typing.Dict`\[:py:class:`str`, :py:data:`~typing.Any`]]], :py:obj:`None`] :param properties: Describes the component's properties. You can't specify ``tags`` as a valid property for ``properties`` . :type schema_version: :py:data:`~typing.Optional`\[:py:class:`str`] :param schema_version: The schema version of the component when it was imported. :type source_id: :py:data:`~typing.Optional`\[:py:class:`str`] :param source_id: The unique ID of the component in its original source system, such as Figma. :type tags: :py:data:`~typing.Optional`\[:py:class:`~typing.Mapping`\[:py:class:`str`, :py:class:`str`]] :param tags: One or more key-value pairs to use when tagging the component. :type variants: :py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~typing.Sequence`\[:py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~aws_cdk.aws_amplifyuibuilder.CfnComponent.ComponentVariantProperty`, :py:class:`~typing.Dict`\[:py:class:`str`, :py:data:`~typing.Any`]]], :py:obj:`None`] :param variants: A list of the component's variants. A variant is a unique style configuration of a main component.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_dependency(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource
) –- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT
). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str
) – The name of the attribute.type_hint (
Optional
[ResolutionTypeHint
]) –
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List
[Union
[Stack
,CfnResource
]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List
[CfnResource
]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource
) – The dependency to replace.new_target (
CfnResource
) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::AmplifyUIBuilder::Component'
- app_id
The unique ID of the Amplify app associated with the component.
- attr_created_at
The time that the component was created.
- CloudformationAttribute:
CreatedAt
- attr_id
The unique ID of the component.
- CloudformationAttribute:
Id
- attr_modified_at
The time that the component was modified.
- CloudformationAttribute:
ModifiedAt
- binding_properties
The information to connect a component’s properties to data at runtime.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- children
A list of the component’s
ComponentChild
instances.
- collection_properties
The data binding configuration for the component’s properties.
- component_type
The type of the component.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- environment_name
The name of the backend environment that is a part of the Amplify app.
- events
Describes the events that can be raised on the component.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- name
The name of the component.
- node
The tree node.
- overrides
Describes the component’s properties that can be overriden in a customized instance of the component.
- properties
Describes the component’s properties.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.
- schema_version
The schema version of the component when it was imported.
- source_id
The unique ID of the component in its original source system, such as Figma.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
Tag Manager which manages the tags for this resource.
- tags_raw
One or more key-value pairs to use when tagging the component.
- variants
A list of the component’s variants.
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any
) –- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any
) –- Return type:
bool
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
ActionParametersProperty
- class CfnComponent.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
orComponentChild
.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 theActionParameters
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 areurl
andanchor
. 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:
- 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 import aws_amplifyuibuilder as amplifyuibuilder # component_property_property_: amplifyuibuilder.CfnComponent.ComponentPropertyProperty action_parameters_property = amplifyuibuilder.CfnComponent.ActionParametersProperty( anchor=amplifyuibuilder.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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.CfnComponent.MutationActionSetStateParameterProperty( component_name="componentName", property="property", set=amplifyuibuilder.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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.
- 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.
- global_
Specifies whether the user should be signed out globally.
Specify this value for an auth sign out action.
- id
The unique ID of the component that the
ActionParameters
apply to.
- model
The name of the data model.
Use when the action performs an operation on an Amplify DataStore model.
- state
A key-value pair that specifies the state property name and its initial value.
- target
The element within the same component to modify when the action occurs.
- type
The type of navigation action.
Valid values are
url
andanchor
. This value is required for a navigation action.
- url
The URL to the location to open.
Specify this value for a navigation action.
ComponentBindingPropertiesValuePropertiesProperty
- class CfnComponent.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:
- 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 import aws_amplifyuibuilder as amplifyuibuilder # predicate_property_: amplifyuibuilder.CfnComponent.PredicateProperty component_binding_properties_value_properties_property = amplifyuibuilder.CfnComponent.ComponentBindingPropertiesValuePropertiesProperty( bucket="bucket", default_value="defaultValue", field="field", key="key", model="model", predicates=[amplifyuibuilder.CfnComponent.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.
- default_value
The default value to assign to the property.
- field
The field to bind the data to.
- key
The storage key for an Amazon S3 bucket.
- model
An Amplify DataStore model.
- predicates
A list of predicates for binding a component’s properties to data.
- slot_name
The name of a component slot.
ComponentBindingPropertiesValueProperty
- class CfnComponent.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:
- 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 import aws_amplifyuibuilder as amplifyuibuilder # predicate_property_: amplifyuibuilder.CfnComponent.PredicateProperty component_binding_properties_value_property = amplifyuibuilder.CfnComponent.ComponentBindingPropertiesValueProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentBindingPropertiesValuePropertiesProperty( bucket="bucket", default_value="defaultValue", field="field", key="key", model="model", predicates=[amplifyuibuilder.CfnComponent.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.
- default_value
The default value of the property.
ComponentChildProperty
- class CfnComponent.ComponentChildProperty(*, component_type, name, properties, children=None, events=None, source_id=None)
Bases:
object
The
ComponentChild
property specifies a nested UI configuration within a parentComponent
.- Parameters:
component_type (
str
) – The type of the child component.name (
str
) – The name of the child component.properties (
Union
[IResolvable
,Mapping
[str
,Union
[IResolvable
,ComponentPropertyProperty
,Dict
[str
,Any
]]]]) – Describes the properties of the child component. You can’t specifytags
as a valid property forproperties
.children (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,ComponentChildProperty
,Dict
[str
,Any
]]],None
]) – The list ofComponentChild
instances for this 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.source_id (
Optional
[str
]) – The unique ID of the child component in its original source system, such as Figma.
- See:
- 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 import aws_amplifyuibuilder as amplifyuibuilder # component_child_property_: amplifyuibuilder.CfnComponent.ComponentChildProperty # component_property_property_: amplifyuibuilder.CfnComponent.ComponentPropertyProperty component_child_property = amplifyuibuilder.CfnComponent.ComponentChildProperty( component_type="componentType", name="name", properties={ "properties_key": amplifyuibuilder.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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" ) }, # the properties below are optional children=[component_child_property_], events={ "events_key": amplifyuibuilder.CfnComponent.ComponentEventProperty( action="action", binding_event="bindingEvent", parameters=amplifyuibuilder.CfnComponent.ActionParametersProperty( anchor=amplifyuibuilder.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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.CfnComponent.MutationActionSetStateParameterProperty( component_name="componentName", property="property", set=amplifyuibuilder.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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.
- component_type
The type of the child component.
- 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.
- name
The name of the child component.
- properties
Describes the properties of the child component.
You can’t specify
tags
as a valid property forproperties
.
- source_id
The unique ID of the child component in its original source system, such as Figma.
ComponentConditionPropertyProperty
- class CfnComponent.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 aseq
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:
- 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 import aws_amplifyuibuilder as amplifyuibuilder # component_condition_property_property_: amplifyuibuilder.CfnComponent.ComponentConditionPropertyProperty # component_property_property_: amplifyuibuilder.CfnComponent.ComponentPropertyProperty component_condition_property_property = amplifyuibuilder.CfnComponent.ComponentConditionPropertyProperty( else=amplifyuibuilder.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), 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.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), 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.
- field
The name of a field.
Specify this when the property is a data model.
- operand
The value of the property to evaluate.
- operand_type
The type of the property to evaluate.
- operator
The operator to use to perform the evaluation, such as
eq
to represent equals.
- property
The name of the conditional property.
- then
The value to assign to the property if the condition is met.
ComponentDataConfigurationProperty
- class CfnComponent.ComponentDataConfigurationProperty(*, model, identifiers=None, predicate=None, sort=None)
Bases:
object
The
ComponentDataConfiguration
property specifies the configuration for binding a component’s properties to data.- Parameters:
model (
str
) – The name of the data model to use to bind data to a component.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.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:
- 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 import aws_amplifyuibuilder as amplifyuibuilder # predicate_property_: amplifyuibuilder.CfnComponent.PredicateProperty component_data_configuration_property = amplifyuibuilder.CfnComponent.ComponentDataConfigurationProperty( model="model", # the properties below are optional identifiers=["identifiers"], predicate=amplifyuibuilder.CfnComponent.PredicateProperty( and=[predicate_property_], field="field", operand="operand", operand_type="operandType", operator="operator", or=[predicate_property_] ), sort=[amplifyuibuilder.CfnComponent.SortPropertyProperty( direction="direction", field="field" )] )
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.
- model
The name of the data model to use to bind data to a component.
- 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.
- sort
Describes how to sort the component’s properties.
ComponentEventProperty
- class CfnComponent.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 aComponentChild
. 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 abindingEvent
, the event is called when the action is performed.parameters (
Union
[IResolvable
,ActionParametersProperty
,Dict
[str
,Any
],None
]) – Describes information about the action.
- See:
- 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 import aws_amplifyuibuilder as amplifyuibuilder # component_property_property_: amplifyuibuilder.CfnComponent.ComponentPropertyProperty component_event_property = amplifyuibuilder.CfnComponent.ComponentEventProperty( action="action", binding_event="bindingEvent", parameters=amplifyuibuilder.CfnComponent.ActionParametersProperty( anchor=amplifyuibuilder.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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.CfnComponent.MutationActionSetStateParameterProperty( component_name="componentName", property="property", set=amplifyuibuilder.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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.
- 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.
- parameters
Describes information about the action.
ComponentPropertyBindingPropertiesProperty
- class CfnComponent.ComponentPropertyBindingPropertiesProperty(*, property, field=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:
property (
str
) – The component property to bind to the data field.field (
Optional
[str
]) – The data field to bind the property to.
- See:
- 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 import aws_amplifyuibuilder as amplifyuibuilder component_property_binding_properties_property = amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" )
Attributes
- field
The data field to bind the property to.
- property
The component property to bind to the data field.
ComponentPropertyProperty
- class CfnComponent.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:
- 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 import aws_amplifyuibuilder as amplifyuibuilder # component_property_property_: amplifyuibuilder.CfnComponent.ComponentPropertyProperty component_property_property = amplifyuibuilder.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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.
- bindings
The information to bind the component property to form data.
- collection_binding_properties
The information to bind the component property to data at runtime.
Use this for collection components.
- component_name
The name of the component that is affected by an event.
- concat
A list of component properties to concatenate to create the value to assign to this component property.
- condition
The conditional expression to use to assign a value to the component property.
- configured
Specifies whether the user configured the property in Amplify Studio after importing it.
- default_value
The default value to assign to the component property.
- event
An event that occurs in your app.
Use this for workflow data binding.
- imported_value
The default value assigned to the property when the component is imported into an app.
- model
The data model to use to assign a value to the component property.
- property
The name of the component’s property that is affected by an event.
- type
The component type.
- user_attribute
An authenticated user attribute to use to assign a value to the component property.
- value
The value to assign to the component property.
ComponentVariantProperty
- class CfnComponent.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 specifytags
as a valid property foroverrides
.variant_values (
Union
[IResolvable
,Mapping
[str
,str
],None
]) – The combination of variants that comprise this variant.
- See:
- 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 import aws_amplifyuibuilder as amplifyuibuilder # overrides: Any component_variant_property = amplifyuibuilder.CfnComponent.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 foroverrides
.
- variant_values
The combination of variants that comprise this variant.
FormBindingElementProperty
- class CfnComponent.FormBindingElementProperty(*, element, property)
Bases:
object
Describes how to bind a component property to form data.
- Parameters:
element (
str
) – The name of the component to retrieve a value from.property (
str
) – The property to retrieve a value from.
- See:
- 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 import aws_amplifyuibuilder as amplifyuibuilder form_binding_element_property = amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" )
Attributes
- element
The name of the component to retrieve a value from.
- property
The property to retrieve a value from.
MutationActionSetStateParameterProperty
- class CfnComponent.MutationActionSetStateParameterProperty(*, component_name, property, set)
Bases:
object
Represents the state configuration when an action modifies a property of another element within the same component.
- Parameters:
component_name (
str
) – The name of the component that is being modified.property (
str
) – The name of the component property to apply the state configuration to.set (
Union
[IResolvable
,ComponentPropertyProperty
,Dict
[str
,Any
]]) – The state configuration to assign to the property.
- See:
- 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 import aws_amplifyuibuilder as amplifyuibuilder # component_property_property_: amplifyuibuilder.CfnComponent.ComponentPropertyProperty mutation_action_set_state_parameter_property = amplifyuibuilder.CfnComponent.MutationActionSetStateParameterProperty( component_name="componentName", property="property", set=amplifyuibuilder.CfnComponent.ComponentPropertyProperty( binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), bindings={ "bindings_key": amplifyuibuilder.CfnComponent.FormBindingElementProperty( element="element", property="property" ) }, collection_binding_properties=amplifyuibuilder.CfnComponent.ComponentPropertyBindingPropertiesProperty( property="property", # the properties below are optional field="field" ), component_name="componentName", concat=[component_property_property_], condition=amplifyuibuilder.CfnComponent.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.
- property
The name of the component property to apply the state configuration to.
- set
The state configuration to assign to the property.
PredicateProperty
- class CfnComponent.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:
- 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 import aws_amplifyuibuilder as amplifyuibuilder # predicate_property_: amplifyuibuilder.CfnComponent.PredicateProperty predicate_property = amplifyuibuilder.CfnComponent.PredicateProperty( and=[predicate_property_], field="field", operand="operand", operand_type="operandType", operator="operator", or=[predicate_property_] )
Attributes
- and_
A list of predicates to combine logically.
- field
The field to query.
- operand
The value to use when performing the evaluation.
- operand_type
The type of value to use when performing the evaluation.
- operator
The operator to use to perform the evaluation.
- or_
A list of predicates to combine logically.
SortPropertyProperty
- class CfnComponent.SortPropertyProperty(*, direction, field)
Bases:
object
The
SortProperty
property specifies how to sort the data that you bind to a component.- Parameters:
direction (
str
) – The direction of the sort, either ascending or descending.field (
str
) – The field to perform the sort on.
- See:
- 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 import aws_amplifyuibuilder as amplifyuibuilder sort_property_property = amplifyuibuilder.CfnComponent.SortPropertyProperty( direction="direction", field="field" )
Attributes
- direction
The direction of the sort, either ascending or descending.
- field
The field to perform the sort on.