CfnComponentProps
- class aws_cdk.aws_amplifyuibuilder.CfnComponentProps(*, 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: - object- Properties for defining a - CfnComponent.- Parameters:
- app_id ( - Optional[- str]) – The unique ID of the Amplify app associated with the component.
- binding_properties ( - Union[- IResolvable,- Mapping[- str,- Union[- IResolvable,- ComponentBindingPropertiesValueProperty,- Dict[- str,- Any]]],- None]) – The information to connect a component’s properties to data at runtime. You can’t specify- tagsas a valid property for- bindingProperties.
- children ( - Union[- IResolvable,- Sequence[- Union[- IResolvable,- ComponentChildProperty,- Dict[- str,- Any]]],- None]) – A list of the component’s- ComponentChildinstances.
- 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 specify- tagsas a valid property for- collectionProperties.
- component_type ( - Optional[- str]) – The type of the component. This can be an Amplify custom UI component or another custom component.
- environment_name ( - Optional[- str]) – The name of the backend environment that is a part of the Amplify app.
- 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.
- name ( - Optional[- 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 specify- tagsas a valid property for- overrides.
- properties ( - Union[- IResolvable,- Mapping[- str,- Union[- IResolvable,- ComponentPropertyProperty,- Dict[- str,- Any]]],- None]) – Describes the component’s properties. You can’t specify- tagsas a valid property for- properties.
- 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.
- variants ( - Union[- IResolvable,- Sequence[- Union[- IResolvable,- ComponentVariantProperty,- Dict[- str,- Any]]],- None]) – A list of the component’s variants. A variant is a unique style configuration of a main component.
 
- See:
- ExampleMetadata:
- fixture=_generated 
 - Example: - .. rubric:: Attributes - app_id
- The unique ID of the Amplify app associated with the component. 
 - binding_properties
- The information to connect a component’s properties to data at runtime. - You can’t specify - tagsas a valid property for- bindingProperties.
 - children
- A list of the component’s - ComponentChildinstances.
 - collection_properties
- The data binding configuration for the component’s properties. - Use this for a collection component. You can’t specify - tagsas a valid property for- collectionProperties.
 - component_type
- The type of the component. - This can be an Amplify custom UI component or another custom component. 
 - 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. - 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 - tagsas a valid property for- overrides.
 - properties
- Describes the component’s properties. - You can’t specify - tagsas a valid property for- properties.
 - 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.