CfnFormMixinProps
- class aws_cdk.mixins_preview.aws_amplifyuibuilder.mixins.CfnFormMixinProps(*, app_id=None, cta=None, data_type=None, environment_name=None, fields=None, form_action_type=None, label_decorator=None, name=None, schema_version=None, sectional_elements=None, style=None, tags=None)
Bases:
objectProperties for CfnFormPropsMixin.
- Parameters:
app_id (
Optional[str]) – The unique ID of the Amplify app associated with the form.cta (
Union[IResolvable,FormCTAProperty,Dict[str,Any],None]) – TheFormCTAobject that stores the call to action configuration for the form.data_type (
Union[IResolvable,FormDataTypeConfigProperty,Dict[str,Any],None]) – The type of data source to use to create the form.environment_name (
Optional[str]) – The name of the backend environment that is a part of the Amplify app.fields (
Union[IResolvable,Mapping[str,Union[IResolvable,FieldConfigProperty,Dict[str,Any]]],None]) – The configuration information for the form’s fields.form_action_type (
Optional[str]) – Specifies whether to perform a create or update action on the form.label_decorator (
Optional[str]) – Specifies an icon or decoration to display on the form.name (
Optional[str]) – The name of the form.schema_version (
Optional[str]) – The schema version of the form.sectional_elements (
Union[IResolvable,Mapping[str,Union[IResolvable,SectionalElementProperty,Dict[str,Any]]],None]) – The configuration information for the visual helper elements for the form. These elements are not associated with any data.style (
Union[IResolvable,FormStyleProperty,Dict[str,Any],None]) – The configuration for the form’s style.tags (
Optional[Mapping[str,str]]) – One or more key-value pairs to use when tagging the form data.
- 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.mixins_preview.aws_amplifyuibuilder import mixins as amplifyuibuilder_mixins # form_input_value_property_property_: amplifyuibuilder_mixins.CfnFormPropsMixin.FormInputValuePropertyProperty cfn_form_mixin_props = amplifyuibuilder_mixins.CfnFormMixinProps( app_id="appId", cta=amplifyuibuilder_mixins.CfnFormPropsMixin.FormCTAProperty( cancel=amplifyuibuilder_mixins.CfnFormPropsMixin.FormButtonProperty( children="children", excluded=False, position=amplifyuibuilder_mixins.CfnFormPropsMixin.FieldPositionProperty( below="below", fixed="fixed", right_of="rightOf" ) ), clear=amplifyuibuilder_mixins.CfnFormPropsMixin.FormButtonProperty( children="children", excluded=False, position=amplifyuibuilder_mixins.CfnFormPropsMixin.FieldPositionProperty( below="below", fixed="fixed", right_of="rightOf" ) ), position="position", submit=amplifyuibuilder_mixins.CfnFormPropsMixin.FormButtonProperty( children="children", excluded=False, position=amplifyuibuilder_mixins.CfnFormPropsMixin.FieldPositionProperty( below="below", fixed="fixed", right_of="rightOf" ) ) ), data_type=amplifyuibuilder_mixins.CfnFormPropsMixin.FormDataTypeConfigProperty( data_source_type="dataSourceType", data_type_name="dataTypeName" ), environment_name="environmentName", fields={ "fields_key": amplifyuibuilder_mixins.CfnFormPropsMixin.FieldConfigProperty( excluded=False, input_type=amplifyuibuilder_mixins.CfnFormPropsMixin.FieldInputConfigProperty( default_checked=False, default_country_code="defaultCountryCode", default_value="defaultValue", descriptive_text="descriptiveText", file_uploader_config=amplifyuibuilder_mixins.CfnFormPropsMixin.FileUploaderFieldConfigProperty( accepted_file_types=["acceptedFileTypes"], access_level="accessLevel", is_resumable=False, max_file_count=123, max_size=123, show_thumbnails=False ), is_array=False, max_value=123, min_value=123, name="name", placeholder="placeholder", read_only=False, required=False, step=123, type="type", value="value", value_mappings=amplifyuibuilder_mixins.CfnFormPropsMixin.ValueMappingsProperty( binding_properties={ "binding_properties_key": amplifyuibuilder_mixins.CfnFormPropsMixin.FormInputBindingPropertiesValueProperty( binding_properties=amplifyuibuilder_mixins.CfnFormPropsMixin.FormInputBindingPropertiesValuePropertiesProperty( model="model" ), type="type" ) }, values=[amplifyuibuilder_mixins.CfnFormPropsMixin.ValueMappingProperty( display_value=amplifyuibuilder_mixins.CfnFormPropsMixin.FormInputValuePropertyProperty( binding_properties=amplifyuibuilder_mixins.CfnFormPropsMixin.FormInputValuePropertyBindingPropertiesProperty( field="field", property="property" ), concat=[form_input_value_property_property_], value="value" ), value=amplifyuibuilder_mixins.CfnFormPropsMixin.FormInputValuePropertyProperty( binding_properties=amplifyuibuilder_mixins.CfnFormPropsMixin.FormInputValuePropertyBindingPropertiesProperty( field="field", property="property" ), concat=[form_input_value_property_property_], value="value" ) )] ) ), label="label", position=amplifyuibuilder_mixins.CfnFormPropsMixin.FieldPositionProperty( below="below", fixed="fixed", right_of="rightOf" ), validations=[amplifyuibuilder_mixins.CfnFormPropsMixin.FieldValidationConfigurationProperty( num_values=[123], str_values=["strValues"], type="type", validation_message="validationMessage" )] ) }, form_action_type="formActionType", label_decorator="labelDecorator", name="name", schema_version="schemaVersion", sectional_elements={ "sectional_elements_key": amplifyuibuilder_mixins.CfnFormPropsMixin.SectionalElementProperty( excluded=False, level=123, orientation="orientation", position=amplifyuibuilder_mixins.CfnFormPropsMixin.FieldPositionProperty( below="below", fixed="fixed", right_of="rightOf" ), text="text", type="type" ) }, style=amplifyuibuilder_mixins.CfnFormPropsMixin.FormStyleProperty( horizontal_gap=amplifyuibuilder_mixins.CfnFormPropsMixin.FormStyleConfigProperty( token_reference="tokenReference", value="value" ), outer_padding=amplifyuibuilder_mixins.CfnFormPropsMixin.FormStyleConfigProperty( token_reference="tokenReference", value="value" ), vertical_gap=amplifyuibuilder_mixins.CfnFormPropsMixin.FormStyleConfigProperty( token_reference="tokenReference", value="value" ) ), tags={ "tags_key": "tags" } )
Attributes
- app_id
The unique ID of the Amplify app associated with the form.
- cta
The
FormCTAobject that stores the call to action configuration for the form.
- data_type
The type of data source to use to create the form.
- environment_name
The name of the backend environment that is a part of the Amplify app.
- fields
The configuration information for the form’s fields.
- form_action_type
Specifies whether to perform a create or update action on the form.
- label_decorator
Specifies an icon or decoration to display on the form.
- name
The name of the form.
- schema_version
The schema version of the form.
- sectional_elements
The configuration information for the visual helper elements for the form.
These elements are not associated with any data.
- style
The configuration for the form’s style.
- tags
One or more key-value pairs to use when tagging the form data.