CfnFormPropsMixin

class aws_cdk.mixins_preview.aws_amplifyuibuilder.mixins.CfnFormPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::AmplifyUIBuilder::Form resource specifies all of the information that is required to create a form.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html
CloudformationResource:: AWS::AmplifyUIBuilder::Form
Mixin:: true
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 import mixins
from aws_cdk.mixins_preview.aws_amplifyuibuilder import mixins as amplifyuibuilder_mixins

# form_input_value_property_property_: amplifyuibuilder_mixins.CfnFormPropsMixin.FormInputValuePropertyProperty

cfn_form_props_mixin = amplifyuibuilder_mixins.CfnFormPropsMixin(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"
    }
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::AmplifyUIBuilder::Form.

Parameters:

props (Union[CfnFormMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['appId', 'cta', 'dataType', 'environmentName', 'fields', 'formActionType', 'labelDecorator', 'name', 'schemaVersion', 'sectionalElements', 'style', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

FieldConfigProperty

class CfnFormPropsMixin.FieldConfigProperty(*, excluded=None, input_type=None, label=None, position=None, validations=None)

Bases: object

The FieldConfig property specifies the configuration information for a field in a table.

Parameters:

excluded (Union[bool, IResolvable, None]) – Specifies whether to hide a field.
input_type (Union[IResolvable, FieldInputConfigProperty, Dict[str, Any], None]) – Describes the configuration for the default input value to display for a field.
label (Optional[str]) – The label for the field.
position (Union[IResolvable, FieldPositionProperty, Dict[str, Any], None]) – Specifies the field position.
validations (Union[IResolvable, Sequence[Union[IResolvable, FieldValidationConfigurationProperty, Dict[str, Any]]], None]) – The validations to perform on the value in the field.

See:

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

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

field_config_property = 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"
    )]
)

Attributes

excluded

Specifies whether to hide a field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldconfig.html#cfn-amplifyuibuilder-form-fieldconfig-excluded

input_type

Describes the configuration for the default input value to display for a field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldconfig.html#cfn-amplifyuibuilder-form-fieldconfig-inputtype

label

The label for the field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldconfig.html#cfn-amplifyuibuilder-form-fieldconfig-label

position

Specifies the field position.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldconfig.html#cfn-amplifyuibuilder-form-fieldconfig-position

validations

The validations to perform on the value in the field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldconfig.html#cfn-amplifyuibuilder-form-fieldconfig-validations

FieldInputConfigProperty

class CfnFormPropsMixin.FieldInputConfigProperty(*, default_checked=None, default_country_code=None, default_value=None, descriptive_text=None, file_uploader_config=None, is_array=None, max_value=None, min_value=None, name=None, placeholder=None, read_only=None, required=None, step=None, type=None, value=None, value_mappings=None)

Bases: object

The FieldInputConfig property specifies the configuration for the default input values to display for a field.

Parameters:

default_checked (Union[bool, IResolvable, None]) – Specifies whether a field has a default value.
default_country_code (Optional[str]) – The default country code for a phone number.
default_value (Optional[str]) – The default value for the field.
descriptive_text (Optional[str]) – The text to display to describe the field.
file_uploader_config (Union[IResolvable, FileUploaderFieldConfigProperty, Dict[str, Any], None]) – The configuration for the file uploader field.
is_array (Union[bool, IResolvable, None]) – Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.
max_value (Union[int, float, None]) – The maximum value to display for the field.
min_value (Union[int, float, None]) – The minimum value to display for the field.
name (Optional[str]) – The name of the field.
placeholder (Optional[str]) – The text to display as a placeholder for the field.
read_only (Union[bool, IResolvable, None]) – Specifies a read only field.
required (Union[bool, IResolvable, None]) – Specifies a field that requires input.
step (Union[int, float, None]) – The stepping increment for a numeric value in a field.
type (Optional[str]) – The input type for the field.
value (Optional[str]) – The value for the field.
value_mappings (Union[IResolvable, ValueMappingsProperty, Dict[str, Any], None]) – The information to use to customize the input fields with data at runtime.

See:

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

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

field_input_config_property = 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"
            )
        )]
    )
)

Attributes

default_checked

Specifies whether a field has a default value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-defaultchecked

default_country_code

The default country code for a phone number.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-defaultcountrycode

default_value

The default value for the field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-defaultvalue

descriptive_text

The text to display to describe the field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-descriptivetext

file_uploader_config

The configuration for the file uploader field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-fileuploaderconfig

is_array

Specifies whether to render the field as an array.

This property is ignored if the dataSourceType for the form is a Data Store.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-isarray

max_value

The maximum value to display for the field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-maxvalue

min_value

The minimum value to display for the field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-minvalue

name

The name of the field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-name

placeholder

The text to display as a placeholder for the field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-placeholder

read_only

Specifies a read only field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-readonly

required

Specifies a field that requires input.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-required

step

The stepping increment for a numeric value in a field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-step

type

The input type for the field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-type

value

The value for the field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-value

value_mappings

The information to use to customize the input fields with data at runtime.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-valuemappings

FieldPositionProperty

class CfnFormPropsMixin.FieldPositionProperty(*, below=None, fixed=None, right_of=None)

Bases: object

The FieldPosition property specifies the field position.

Parameters:

below (Optional[str]) – The field position is below the field specified by the string.
fixed (Optional[str]) – The field position is fixed and doesn’t change in relation to other fields.
right_of (Optional[str]) – The field position is to the right of the field specified by the string.

See:

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

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

field_position_property = amplifyuibuilder_mixins.CfnFormPropsMixin.FieldPositionProperty(
    below="below",
    fixed="fixed",
    right_of="rightOf"
)

Attributes

below

The field position is below the field specified by the string.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldposition.html#cfn-amplifyuibuilder-form-fieldposition-below

fixed

The field position is fixed and doesn’t change in relation to other fields.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldposition.html#cfn-amplifyuibuilder-form-fieldposition-fixed

right_of

The field position is to the right of the field specified by the string.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldposition.html#cfn-amplifyuibuilder-form-fieldposition-rightof

FieldValidationConfigurationProperty

class CfnFormPropsMixin.FieldValidationConfigurationProperty(*, num_values=None, str_values=None, type=None, validation_message=None)

Bases: object

The FieldValidationConfiguration property specifies the validation configuration for a field.

Parameters:

num_values (Union[Sequence[Union[int, float]], IResolvable, None]) – The validation to perform on a number value.
str_values (Optional[Sequence[str]]) – The validation to perform on a string value.
type (Optional[str]) – The validation to perform on an object type. ``
validation_message (Optional[str]) – The validation message to display.

See:

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

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

field_validation_configuration_property = amplifyuibuilder_mixins.CfnFormPropsMixin.FieldValidationConfigurationProperty(
    num_values=[123],
    str_values=["strValues"],
    type="type",
    validation_message="validationMessage"
)

Attributes

num_values

The validation to perform on a number value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldvalidationconfiguration.html#cfn-amplifyuibuilder-form-fieldvalidationconfiguration-numvalues

str_values

The validation to perform on a string value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldvalidationconfiguration.html#cfn-amplifyuibuilder-form-fieldvalidationconfiguration-strvalues

type

The validation to perform on an object type.

``

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldvalidationconfiguration.html#cfn-amplifyuibuilder-form-fieldvalidationconfiguration-type

validation_message

The validation message to display.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldvalidationconfiguration.html#cfn-amplifyuibuilder-form-fieldvalidationconfiguration-validationmessage

FileUploaderFieldConfigProperty

class CfnFormPropsMixin.FileUploaderFieldConfigProperty(*, accepted_file_types=None, access_level=None, is_resumable=None, max_file_count=None, max_size=None, show_thumbnails=None)

Bases: object

Describes the configuration for the file uploader field.

Parameters:

accepted_file_types (Optional[Sequence[str]]) – The file types that are allowed to be uploaded by the file uploader. Provide this information in an array of strings specifying the valid file extensions.
access_level (Optional[str]) – The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values for this property are private , protected , or public . For detailed information about the permissions associated with each access level, see File access levels in the Amplify documentation .
is_resumable (Union[bool, IResolvable, None]) – Allows the file upload operation to be paused and resumed. The default value is false . When isResumable is set to true , the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn’t continuous, because the file uploader uploads a chunk at a time.
max_file_count (Union[int, float, None]) – Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.
max_size (Union[int, float, None]) – The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.
show_thumbnails (Union[bool, IResolvable, None]) – Specifies whether to display or hide the image preview after selecting a file for upload. The default value is true to display the image preview.

See:

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

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

file_uploader_field_config_property = amplifyuibuilder_mixins.CfnFormPropsMixin.FileUploaderFieldConfigProperty(
    accepted_file_types=["acceptedFileTypes"],
    access_level="accessLevel",
    is_resumable=False,
    max_file_count=123,
    max_size=123,
    show_thumbnails=False
)

Attributes

accepted_file_types

The file types that are allowed to be uploaded by the file uploader.

Provide this information in an array of strings specifying the valid file extensions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html#cfn-amplifyuibuilder-form-fileuploaderfieldconfig-acceptedfiletypes

access_level

The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored.

The valid values for this property are private , protected , or public . For detailed information about the permissions associated with each access level, see File access levels in the Amplify documentation .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html#cfn-amplifyuibuilder-form-fileuploaderfieldconfig-accesslevel

is_resumable

Allows the file upload operation to be paused and resumed. The default value is false .

When isResumable is set to true , the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn’t continuous, because the file uploader uploads a chunk at a time.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html#cfn-amplifyuibuilder-form-fileuploaderfieldconfig-isresumable

max_file_count

Specifies the maximum number of files that can be selected to upload.

The default value is an unlimited number of files.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html#cfn-amplifyuibuilder-form-fileuploaderfieldconfig-maxfilecount

max_size

The maximum file size in bytes that the file uploader will accept.

The default value is an unlimited file size.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html#cfn-amplifyuibuilder-form-fileuploaderfieldconfig-maxsize

show_thumbnails

Specifies whether to display or hide the image preview after selecting a file for upload.

The default value is true to display the image preview.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html#cfn-amplifyuibuilder-form-fileuploaderfieldconfig-showthumbnails

FormButtonProperty

class CfnFormPropsMixin.FormButtonProperty(*, children=None, excluded=None, position=None)

Bases: object

The FormButton property specifies the configuration for a button UI element that is a part of a form.

Parameters:

children (Optional[str]) – Describes the button’s properties.
excluded (Union[bool, IResolvable, None]) – Specifies whether the button is visible on the form.
position (Union[IResolvable, FieldPositionProperty, Dict[str, Any], None]) – The position of the button.

See:

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

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_button_property = amplifyuibuilder_mixins.CfnFormPropsMixin.FormButtonProperty(
    children="children",
    excluded=False,
    position=amplifyuibuilder_mixins.CfnFormPropsMixin.FieldPositionProperty(
        below="below",
        fixed="fixed",
        right_of="rightOf"
    )
)

Attributes

children

Describes the button’s properties.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formbutton.html#cfn-amplifyuibuilder-form-formbutton-children

excluded

Specifies whether the button is visible on the form.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formbutton.html#cfn-amplifyuibuilder-form-formbutton-excluded

position

The position of the button.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formbutton.html#cfn-amplifyuibuilder-form-formbutton-position

FormCTAProperty

class CfnFormPropsMixin.FormCTAProperty(*, cancel=None, clear=None, position=None, submit=None)

Bases: object

The FormCTA property specifies the call to action button configuration for the form.

Parameters:

cancel (Union[IResolvable, FormButtonProperty, Dict[str, Any], None]) – Displays a cancel button.
clear (Union[IResolvable, FormButtonProperty, Dict[str, Any], None]) – Displays a clear button.
position (Optional[str]) – The position of the button.
submit (Union[IResolvable, FormButtonProperty, Dict[str, Any], None]) – Displays a submit button.

See:

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

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_cTAProperty = 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"
        )
    )
)

Attributes

cancel

Displays a cancel button.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formcta.html#cfn-amplifyuibuilder-form-formcta-cancel

clear

Displays a clear button.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formcta.html#cfn-amplifyuibuilder-form-formcta-clear

position

The position of the button.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formcta.html#cfn-amplifyuibuilder-form-formcta-position

submit

Displays a submit button.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formcta.html#cfn-amplifyuibuilder-form-formcta-submit

FormDataTypeConfigProperty

class CfnFormPropsMixin.FormDataTypeConfigProperty(*, data_source_type=None, data_type_name=None)

Bases: object

The FormDataTypeConfig property specifies the data type configuration for the data source associated with a form.

Parameters:

data_source_type (Optional[str]) – The data source type, either an Amplify DataStore model or a custom data type.
data_type_name (Optional[str]) – The unique name of the data type you are using as the data source for the form.

See:

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

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_data_type_config_property = amplifyuibuilder_mixins.CfnFormPropsMixin.FormDataTypeConfigProperty(
    data_source_type="dataSourceType",
    data_type_name="dataTypeName"
)

Attributes

data_source_type

The data source type, either an Amplify DataStore model or a custom data type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formdatatypeconfig.html#cfn-amplifyuibuilder-form-formdatatypeconfig-datasourcetype

data_type_name

The unique name of the data type you are using as the data source for the form.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formdatatypeconfig.html#cfn-amplifyuibuilder-form-formdatatypeconfig-datatypename

FormInputBindingPropertiesValuePropertiesProperty

class CfnFormPropsMixin.FormInputBindingPropertiesValuePropertiesProperty(*, model=None)

Bases: object

Represents 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 Amplify DataStore model.

Parameters:: model (Optional[str]) – An Amplify DataStore model.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputbindingpropertiesvalueproperties.html
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_binding_properties_value_properties_property = amplifyuibuilder_mixins.CfnFormPropsMixin.FormInputBindingPropertiesValuePropertiesProperty(
    model="model"
)

Attributes

model

An Amplify DataStore model.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputbindingpropertiesvalueproperties.html#cfn-amplifyuibuilder-form-forminputbindingpropertiesvalueproperties-model

FormInputBindingPropertiesValueProperty

class CfnFormPropsMixin.FormInputBindingPropertiesValueProperty(*, binding_properties=None, type=None)

Bases: object

Represents the data binding configuration for a form’s input fields at runtime.You can use FormInputBindingPropertiesValue to add exposed properties to a form to allow different values to be entered when a form is reused in different places in an app.

Parameters:

binding_properties (Union[IResolvable, FormInputBindingPropertiesValuePropertiesProperty, Dict[str, Any], None]) – Describes the properties to customize with data at runtime.
type (Optional[str]) – The property type.

See:

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

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_binding_properties_value_property = amplifyuibuilder_mixins.CfnFormPropsMixin.FormInputBindingPropertiesValueProperty(
    binding_properties=amplifyuibuilder_mixins.CfnFormPropsMixin.FormInputBindingPropertiesValuePropertiesProperty(
        model="model"
    ),
    type="type"
)

Attributes

binding_properties

Describes the properties to customize with data at runtime.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputbindingpropertiesvalue.html#cfn-amplifyuibuilder-form-forminputbindingpropertiesvalue-bindingproperties

type

The property type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputbindingpropertiesvalue.html#cfn-amplifyuibuilder-form-forminputbindingpropertiesvalue-type

FormInputValuePropertyBindingPropertiesProperty

class CfnFormPropsMixin.FormInputValuePropertyBindingPropertiesProperty(*, field=None, property=None)

Bases: object

Associates a form property to a binding property.

This enables exposed properties on the top level form to propagate data to the form’s property values.

Parameters:

field (Optional[str]) – The data field to bind the property to.
property (Optional[str]) – The form property to bind to the data field.

See:

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

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_binding_properties_property = amplifyuibuilder_mixins.CfnFormPropsMixin.FormInputValuePropertyBindingPropertiesProperty(
    field="field",
    property="property"
)

Attributes

field

The data field to bind the property to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputvaluepropertybindingproperties.html#cfn-amplifyuibuilder-form-forminputvaluepropertybindingproperties-field

property

The form property to bind to the data field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputvaluepropertybindingproperties.html#cfn-amplifyuibuilder-form-forminputvaluepropertybindingproperties-property

FormInputValuePropertyProperty

class CfnFormPropsMixin.FormInputValuePropertyProperty(*, binding_properties=None, concat=None, value=None)

Bases: object

The FormInputValueProperty property specifies the configuration for an input field on a form.

Use FormInputValueProperty to specify the values to render or bind by default.

Parameters:

binding_properties (Union[IResolvable, FormInputValuePropertyBindingPropertiesProperty, Dict[str, Any], None]) – The information to bind fields to data at runtime.
concat (Union[IResolvable, Sequence[Union[IResolvable, FormInputValuePropertyProperty, Dict[str, Any]]], None]) – A list of form properties to concatenate to create the value to assign to this field property.
value (Optional[str]) – The value to assign to the input field.

See:

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

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

form_input_value_property_property = amplifyuibuilder_mixins.CfnFormPropsMixin.FormInputValuePropertyProperty(
    binding_properties=amplifyuibuilder_mixins.CfnFormPropsMixin.FormInputValuePropertyBindingPropertiesProperty(
        field="field",
        property="property"
    ),
    concat=[form_input_value_property_property_],
    value="value"
)

Attributes

binding_properties

The information to bind fields to data at runtime.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputvalueproperty.html#cfn-amplifyuibuilder-form-forminputvalueproperty-bindingproperties

concat

A list of form properties to concatenate to create the value to assign to this field property.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputvalueproperty.html#cfn-amplifyuibuilder-form-forminputvalueproperty-concat

value

The value to assign to the input field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputvalueproperty.html#cfn-amplifyuibuilder-form-forminputvalueproperty-value

FormStyleConfigProperty

class CfnFormPropsMixin.FormStyleConfigProperty(*, token_reference=None, value=None)

Bases: object

The FormStyleConfig property specifies the configuration settings for the form’s style properties.

Parameters:

token_reference (Optional[str]) – A reference to a design token to use to bind the form’s style properties to an existing theme.
value (Optional[str]) – The value of the style setting.

See:

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

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_style_config_property = amplifyuibuilder_mixins.CfnFormPropsMixin.FormStyleConfigProperty(
    token_reference="tokenReference",
    value="value"
)

Attributes

token_reference

A reference to a design token to use to bind the form’s style properties to an existing theme.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyleconfig.html#cfn-amplifyuibuilder-form-formstyleconfig-tokenreference

value

The value of the style setting.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyleconfig.html#cfn-amplifyuibuilder-form-formstyleconfig-value

FormStyleProperty

class CfnFormPropsMixin.FormStyleProperty(*, horizontal_gap=None, outer_padding=None, vertical_gap=None)

Bases: object

The FormStyle property specifies the configuration for the form’s style.

Parameters:

horizontal_gap (Union[IResolvable, FormStyleConfigProperty, Dict[str, Any], None]) – The spacing for the horizontal gap.
outer_padding (Union[IResolvable, FormStyleConfigProperty, Dict[str, Any], None]) – The size of the outer padding for the form.
vertical_gap (Union[IResolvable, FormStyleConfigProperty, Dict[str, Any], None]) – The spacing for the vertical gap.

See:

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

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_style_property = 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"
    )
)

Attributes

horizontal_gap

The spacing for the horizontal gap.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyle.html#cfn-amplifyuibuilder-form-formstyle-horizontalgap

outer_padding

The size of the outer padding for the form.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyle.html#cfn-amplifyuibuilder-form-formstyle-outerpadding

vertical_gap

The spacing for the vertical gap.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyle.html#cfn-amplifyuibuilder-form-formstyle-verticalgap

SectionalElementProperty

class CfnFormPropsMixin.SectionalElementProperty(*, excluded=None, level=None, orientation=None, position=None, text=None, type=None)

Bases: object

The SectionalElement property specifies the configuration information for a visual helper element for a form.

A sectional element can be a header, a text block, or a divider. These elements are static and not associated with any data.

Parameters:

excluded (Union[bool, IResolvable, None]) – Excludes a sectional element that was generated by default for a specified data model.
level (Union[int, float, None]) – Specifies the size of the font for a Heading sectional element. Valid values are 1 | 2 | 3 | 4 | 5 | 6 .
orientation (Optional[str]) – Specifies the orientation for a Divider sectional element. Valid values are horizontal or vertical .
position (Union[IResolvable, FieldPositionProperty, Dict[str, Any], None]) – Specifies the position of the text in a field for a Text sectional element.
text (Optional[str]) – The text for a Text sectional element.
type (Optional[str]) – The type of sectional element. Valid values are Heading , Text , and Divider .

See:

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

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

sectional_element_property = 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"
)

Attributes

excluded

Excludes a sectional element that was generated by default for a specified data model.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html#cfn-amplifyuibuilder-form-sectionalelement-excluded

level

Specifies the size of the font for a Heading sectional element.

Valid values are 1 | 2 | 3 | 4 | 5 | 6 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html#cfn-amplifyuibuilder-form-sectionalelement-level

orientation

Specifies the orientation for a Divider sectional element.

Valid values are horizontal or vertical .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html#cfn-amplifyuibuilder-form-sectionalelement-orientation

position

Specifies the position of the text in a field for a Text sectional element.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html#cfn-amplifyuibuilder-form-sectionalelement-position

text

The text for a Text sectional element.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html#cfn-amplifyuibuilder-form-sectionalelement-text

type

The type of sectional element.

Valid values are Heading , Text , and Divider .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html#cfn-amplifyuibuilder-form-sectionalelement-type

ValueMappingProperty

class CfnFormPropsMixin.ValueMappingProperty(*, display_value=None, value=None)

Bases: object

The ValueMapping property specifies the association between a complex object and a display value.

Use ValueMapping to store how to represent complex objects when they are displayed.

Parameters:

display_value (Union[IResolvable, FormInputValuePropertyProperty, Dict[str, Any], None]) – The value to display for the complex object.
value (Union[IResolvable, FormInputValuePropertyProperty, Dict[str, Any], None]) – The complex object.

See:

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

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

value_mapping_property = 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"
    )
)

Attributes

display_value

The value to display for the complex object.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-valuemapping.html#cfn-amplifyuibuilder-form-valuemapping-displayvalue

value

The complex object.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-valuemapping.html#cfn-amplifyuibuilder-form-valuemapping-value

ValueMappingsProperty

class CfnFormPropsMixin.ValueMappingsProperty(*, binding_properties=None, values=None)

Bases: object

The ValueMappings property specifies the data binding configuration for a value map.

Parameters:

binding_properties (Union[IResolvable, Mapping[str, Union[IResolvable, FormInputBindingPropertiesValueProperty, Dict[str, Any]]], None]) – The information to bind fields to data at runtime.
values (Union[IResolvable, Sequence[Union[IResolvable, ValueMappingProperty, Dict[str, Any]]], None]) – The value and display value pairs.

See:

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

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

value_mappings_property = 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"
        )
    )]
)

Attributes

binding_properties

The information to bind fields to data at runtime.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-valuemappings.html#cfn-amplifyuibuilder-form-valuemappings-bindingproperties

values

The value and display value pairs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-valuemappings.html#cfn-amplifyuibuilder-form-valuemappings-values