CfnComponentProps
- class aws_cdk.aws_amplifyuibuilder.CfnComponentProps(*, binding_properties, component_type, name, overrides, properties, variants, app_id=None, children=None, collection_properties=None, environment_name=None, events=None, schema_version=None, source_id=None, tags=None)
Bases:
object
Properties for defining a
CfnComponent
.- Parameters:
binding_properties (
Union
[Mapping
[str
,Union
[IResolvable
,ComponentBindingPropertiesValueProperty
,Dict
[str
,Any
]]],IResolvable
]) – The information to connect a component’s properties to data at runtime. You can’t specifytags
as a valid property forbindingProperties
.component_type (
str
) – The type of the component. This can be an Amplify custom UI component or another custom component.name (
str
) – The name of the component.overrides (
Any
) – Describes the component’s properties that can be overriden in a customized instance of the component. You can’t specifytags
as a valid property foroverrides
.properties (
Union
[IResolvable
,Mapping
[str
,Union
[IResolvable
,ComponentPropertyProperty
,Dict
[str
,Any
]]]]) – Describes the component’s properties. You can’t specifytags
as a valid property forproperties
.variants (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,ComponentVariantProperty
,Dict
[str
,Any
]]]]) – A list of the component’s variants. A variant is a unique style configuration of a main component.app_id (
Optional
[str
]) –AWS::AmplifyUIBuilder::Component.AppId
.children (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,ComponentChildProperty
,Dict
[str
,Any
]]],None
]) – A list of the component’sComponentChild
instances.collection_properties (
Union
[IResolvable
,Mapping
[str
,Union
[IResolvable
,ComponentDataConfigurationProperty
,Dict
[str
,Any
]]],None
]) – The data binding configuration for the component’s properties. Use this for a collection component. You can’t specifytags
as a valid property forcollectionProperties
.environment_name (
Optional
[str
]) –AWS::AmplifyUIBuilder::Component.EnvironmentName
.events (
Union
[IResolvable
,Mapping
[str
,Union
[IResolvable
,ComponentEventProperty
,Dict
[str
,Any
]]],None
]) – 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.schema_version (
Optional
[str
]) – The schema version of the component when it was imported.source_id (
Optional
[str
]) – The unique ID of the component in its original source system, such as Figma.tags (
Optional
[Mapping
[str
,str
]]) – One or more key-value pairs to use when tagging the component.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_amplifyuibuilder as amplifyuibuilder # component_child_property_: amplifyuibuilder.CfnComponent.ComponentChildProperty # component_property_property_: amplifyuibuilder.CfnComponent.ComponentPropertyProperty # overrides: Any # predicate_property_: amplifyuibuilder.CfnComponent.PredicateProperty cfn_component_props = amplifyuibuilder.CfnComponentProps( binding_properties={ "binding_properties_key": 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", operator="operator", or=[predicate_property_] )], user_attribute="userAttribute" ), default_value="defaultValue", type="type" ) }, component_type="componentType", name="name", overrides=overrides, 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" ) }, variants=[amplifyuibuilder.CfnComponent.ComponentVariantProperty( overrides=overrides, variant_values={ "variant_values_key": "variantValues" } )], # the properties below are optional app_id="appId", children=[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", 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" ) ) ) } )], collection_properties={ "collection_properties_key": amplifyuibuilder.CfnComponent.ComponentDataConfigurationProperty( model="model", # the properties below are optional identifiers=["identifiers"], predicate=amplifyuibuilder.CfnComponent.PredicateProperty( and=[predicate_property_], field="field", operand="operand", operator="operator", or=[predicate_property_] ), sort=[amplifyuibuilder.CfnComponent.SortPropertyProperty( direction="direction", field="field" )] ) }, environment_name="environmentName", events={ "events_key": amplifyuibuilder.CfnComponent.ComponentEventProperty( action="action", 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" ) ) ) }, schema_version="schemaVersion", source_id="sourceId", tags={ "tags_key": "tags" } )
Attributes
- app_id
AWS::AmplifyUIBuilder::Component.AppId
.
- binding_properties
The information to connect a component’s properties to data at runtime.
You can’t specify
tags
as a valid property forbindingProperties
.
- children
A list of the component’s
ComponentChild
instances.
- 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 forcollectionProperties
.
- component_type
The type of the component.
This can be an Amplify custom UI component or another custom component.
- environment_name
AWS::AmplifyUIBuilder::Component.EnvironmentName
.
- 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.
- name
The name of the component.
- 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 foroverrides
.
- properties
Describes the component’s properties.
You can’t specify
tags
as a valid property forproperties
.
- 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.
- tags
One or more key-value pairs to use when tagging the component.
- variants
A list of the component’s variants.
A variant is a unique style configuration of a main component.