CfnFormProps

class aws_cdk.aws_amplifyuibuilder.CfnFormProps(*, data_type, fields, form_action_type, name, schema_version, sectional_elements, style, app_id=None, cta=None, environment_name=None, label_decorator=None, tags=None)

Bases: object

Properties for defining a CfnForm.

Parameters:

data_type (Union[IResolvable, FormDataTypeConfigProperty, Dict[str, Any]]) – The type of data source to use to create the form.
fields (Union[IResolvable, Mapping[str, Union[IResolvable, FieldConfigProperty, Dict[str, Any]]]]) – The configuration information for the form’s fields.
form_action_type (str) – Specifies whether to perform a create or update action on the form.
name (str) – The name of the form.
schema_version (str) – The schema version of the form.
sectional_elements (Union[IResolvable, Mapping[str, Union[IResolvable, SectionalElementProperty, Dict[str, Any]]]]) – 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]]) – The configuration for the form’s style.
app_id (Optional[str]) – The unique ID of the Amplify app associated with the form.
cta (Union[IResolvable, FormCTAProperty, Dict[str, Any], None]) – The FormCTA object that stores the call to action configuration for the form.
environment_name (Optional[str]) – The name of the backend environment that is a part of the Amplify app.
label_decorator (Optional[str]) – AWS::AmplifyUIBuilder::Form.LabelDecorator.
tags (Optional[Mapping[str, str]]) – One or more key-value pairs to use when tagging the form data.

Link:

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

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

cfn_form_props = amplifyuibuilder.CfnFormProps(
    data_type=amplifyuibuilder.CfnForm.FormDataTypeConfigProperty(
        data_source_type="dataSourceType",
        data_type_name="dataTypeName"
    ),
    fields={
        "fields_key": amplifyuibuilder.CfnForm.FieldConfigProperty(
            excluded=False,
            input_type=amplifyuibuilder.CfnForm.FieldInputConfigProperty(
                type="type",

                # the properties below are optional
                default_checked=False,
                default_country_code="defaultCountryCode",
                default_value="defaultValue",
                descriptive_text="descriptiveText",
                file_uploader_config=amplifyuibuilder.CfnForm.FileUploaderFieldConfigProperty(
                    accepted_file_types=["acceptedFileTypes"],
                    access_level="accessLevel",

                    # the properties below are optional
                    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,
                value="value",
                value_mappings=amplifyuibuilder.CfnForm.ValueMappingsProperty(
                    values=[amplifyuibuilder.CfnForm.ValueMappingProperty(
                        value=amplifyuibuilder.CfnForm.FormInputValuePropertyProperty(
                            value="value"
                        ),

                        # the properties below are optional
                        display_value=amplifyuibuilder.CfnForm.FormInputValuePropertyProperty(
                            value="value"
                        )
                    )]
                )
            ),
            label="label",
            position=amplifyuibuilder.CfnForm.FieldPositionProperty(
                below="below",
                fixed="fixed",
                right_of="rightOf"
            ),
            validations=[amplifyuibuilder.CfnForm.FieldValidationConfigurationProperty(
                type="type",

                # the properties below are optional
                num_values=[123],
                str_values=["strValues"],
                validation_message="validationMessage"
            )]
        )
    },
    form_action_type="formActionType",
    name="name",
    schema_version="schemaVersion",
    sectional_elements={
        "sectional_elements_key": amplifyuibuilder.CfnForm.SectionalElementProperty(
            type="type",

            # the properties below are optional
            excluded=False,
            level=123,
            orientation="orientation",
            position=amplifyuibuilder.CfnForm.FieldPositionProperty(
                below="below",
                fixed="fixed",
                right_of="rightOf"
            ),
            text="text"
        )
    },
    style=amplifyuibuilder.CfnForm.FormStyleProperty(
        horizontal_gap=amplifyuibuilder.CfnForm.FormStyleConfigProperty(
            token_reference="tokenReference",
            value="value"
        ),
        outer_padding=amplifyuibuilder.CfnForm.FormStyleConfigProperty(
            token_reference="tokenReference",
            value="value"
        ),
        vertical_gap=amplifyuibuilder.CfnForm.FormStyleConfigProperty(
            token_reference="tokenReference",
            value="value"
        )
    ),

    # the properties below are optional
    app_id="appId",
    cta=amplifyuibuilder.CfnForm.FormCTAProperty(
        cancel=amplifyuibuilder.CfnForm.FormButtonProperty(
            children="children",
            excluded=False,
            position=amplifyuibuilder.CfnForm.FieldPositionProperty(
                below="below",
                fixed="fixed",
                right_of="rightOf"
            )
        ),
        clear=amplifyuibuilder.CfnForm.FormButtonProperty(
            children="children",
            excluded=False,
            position=amplifyuibuilder.CfnForm.FieldPositionProperty(
                below="below",
                fixed="fixed",
                right_of="rightOf"
            )
        ),
        position="position",
        submit=amplifyuibuilder.CfnForm.FormButtonProperty(
            children="children",
            excluded=False,
            position=amplifyuibuilder.CfnForm.FieldPositionProperty(
                below="below",
                fixed="fixed",
                right_of="rightOf"
            )
        )
    ),
    environment_name="environmentName",
    label_decorator="labelDecorator",
    tags={
        "tags_key": "tags"
    }
)