CfnForm

class aws_cdk.aws_amplifyuibuilder.CfnForm(scope, id, *, 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: CfnResource

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

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 import aws_amplifyuibuilder as amplifyuibuilder

# form_input_value_property_property_: amplifyuibuilder.CfnForm.FormInputValuePropertyProperty

cfn_form = amplifyuibuilder.CfnForm(self, "MyCfnForm",
    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"
            )
        )
    ),
    data_type=amplifyuibuilder.CfnForm.FormDataTypeConfigProperty(
        data_source_type="dataSourceType",
        data_type_name="dataTypeName"
    ),
    environment_name="environmentName",
    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(
                            binding_properties=amplifyuibuilder.CfnForm.FormInputValuePropertyBindingPropertiesProperty(
                                property="property",

                                # the properties below are optional
                                field="field"
                            ),
                            concat=[form_input_value_property_property_],
                            value="value"
                        ),

                        # the properties below are optional
                        display_value=amplifyuibuilder.CfnForm.FormInputValuePropertyProperty(
                            binding_properties=amplifyuibuilder.CfnForm.FormInputValuePropertyBindingPropertiesProperty(
                                property="property",

                                # the properties below are optional
                                field="field"
                            ),
                            concat=[form_input_value_property_property_],
                            value="value"
                        )
                    )],

                    # the properties below are optional
                    binding_properties={
                        "binding_properties_key": amplifyuibuilder.CfnForm.FormInputBindingPropertiesValueProperty(
                            binding_properties=amplifyuibuilder.CfnForm.FormInputBindingPropertiesValuePropertiesProperty(
                                model="model"
                            ),
                            type="type"
                        )
                    }
                )
            ),
            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",
    label_decorator="labelDecorator",
    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"
        )
    ),
    tags={
        "tags_key": "tags"
    }
)
Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • 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.

  • 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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str) –

  • value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::AmplifyUIBuilder::Form'
app_id

The unique ID of the Amplify app associated with the form.

attr_id

The ID for the form.

CloudformationAttribute:

Id

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

cta

The FormCTA object 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.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

The name of the form.

node

The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

schema_version

The schema version of the form.

sectional_elements

The configuration information for the visual helper elements for the form.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

style

The configuration for the form’s style.

tags

Tag Manager which manages the tags for this resource.

tags_raw

One or more key-value pairs to use when tagging the form data.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

FieldConfigProperty

class CfnForm.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:
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 import aws_amplifyuibuilder as amplifyuibuilder

# form_input_value_property_property_: amplifyuibuilder.CfnForm.FormInputValuePropertyProperty

field_config_property = 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(
                    binding_properties=amplifyuibuilder.CfnForm.FormInputValuePropertyBindingPropertiesProperty(
                        property="property",

                        # the properties below are optional
                        field="field"
                    ),
                    concat=[form_input_value_property_property_],
                    value="value"
                ),

                # the properties below are optional
                display_value=amplifyuibuilder.CfnForm.FormInputValuePropertyProperty(
                    binding_properties=amplifyuibuilder.CfnForm.FormInputValuePropertyBindingPropertiesProperty(
                        property="property",

                        # the properties below are optional
                        field="field"
                    ),
                    concat=[form_input_value_property_property_],
                    value="value"
                )
            )],

            # the properties below are optional
            binding_properties={
                "binding_properties_key": amplifyuibuilder.CfnForm.FormInputBindingPropertiesValueProperty(
                    binding_properties=amplifyuibuilder.CfnForm.FormInputBindingPropertiesValuePropertiesProperty(
                        model="model"
                    ),
                    type="type"
                )
            }
        )
    ),
    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"
    )]
)

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 CfnForm.FieldInputConfigProperty(*, type, 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, value=None, value_mappings=None)

Bases: object

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

Parameters:

  • type (str) – The input type for the field.

  • 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.

  • 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 import aws_amplifyuibuilder as amplifyuibuilder

# form_input_value_property_property_: amplifyuibuilder.CfnForm.FormInputValuePropertyProperty

field_input_config_property = 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(
                binding_properties=amplifyuibuilder.CfnForm.FormInputValuePropertyBindingPropertiesProperty(
                    property="property",

                    # the properties below are optional
                    field="field"
                ),
                concat=[form_input_value_property_property_],
                value="value"
            ),

            # the properties below are optional
            display_value=amplifyuibuilder.CfnForm.FormInputValuePropertyProperty(
                binding_properties=amplifyuibuilder.CfnForm.FormInputValuePropertyBindingPropertiesProperty(
                    property="property",

                    # the properties below are optional
                    field="field"
                ),
                concat=[form_input_value_property_property_],
                value="value"
            )
        )],

        # the properties below are optional
        binding_properties={
            "binding_properties_key": amplifyuibuilder.CfnForm.FormInputBindingPropertiesValueProperty(
                binding_properties=amplifyuibuilder.CfnForm.FormInputBindingPropertiesValuePropertiesProperty(
                    model="model"
                ),
                type="type"
            )
        }
    )
)

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 CfnForm.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 import aws_amplifyuibuilder as amplifyuibuilder

field_position_property = amplifyuibuilder.CfnForm.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 CfnForm.FieldValidationConfigurationProperty(*, type, num_values=None, str_values=None, validation_message=None)

Bases: object

The FieldValidationConfiguration property specifies the validation configuration for a field.

Parameters:

  • type (str) – The validation to perform on an object type. ``

  • 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.

  • 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 import aws_amplifyuibuilder as amplifyuibuilder

field_validation_configuration_property = amplifyuibuilder.CfnForm.FieldValidationConfigurationProperty(
    type="type",

    # the properties below are optional
    num_values=[123],
    str_values=["strValues"],
    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 CfnForm.FileUploaderFieldConfigProperty(*, accepted_file_types, access_level, 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 (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 (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 import aws_amplifyuibuilder as amplifyuibuilder

file_uploader_field_config_property = 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
)

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 CfnForm.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 import aws_amplifyuibuilder as amplifyuibuilder

form_button_property = amplifyuibuilder.CfnForm.FormButtonProperty(
    children="children",
    excluded=False,
    position=amplifyuibuilder.CfnForm.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 CfnForm.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:
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 import aws_amplifyuibuilder as amplifyuibuilder

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

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 CfnForm.FormDataTypeConfigProperty(*, data_source_type, data_type_name)

Bases: object

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

Parameters:

  • data_source_type (str) – The data source type, either an Amplify DataStore model or a custom data type.

  • data_type_name (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 import aws_amplifyuibuilder as amplifyuibuilder

form_data_type_config_property = amplifyuibuilder.CfnForm.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 CfnForm.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 import aws_amplifyuibuilder as amplifyuibuilder

form_input_binding_properties_value_properties_property = amplifyuibuilder.CfnForm.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 CfnForm.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:
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 import aws_amplifyuibuilder as amplifyuibuilder

form_input_binding_properties_value_property = amplifyuibuilder.CfnForm.FormInputBindingPropertiesValueProperty(
    binding_properties=amplifyuibuilder.CfnForm.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 CfnForm.FormInputValuePropertyBindingPropertiesProperty(*, property, field=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:

  • property (str) – The form property to bind to the data field.

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

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 import aws_amplifyuibuilder as amplifyuibuilder

form_input_value_property_binding_properties_property = amplifyuibuilder.CfnForm.FormInputValuePropertyBindingPropertiesProperty(
    property="property",

    # the properties below are optional
    field="field"
)

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 CfnForm.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:
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 import aws_amplifyuibuilder as amplifyuibuilder

# form_input_value_property_property_: amplifyuibuilder.CfnForm.FormInputValuePropertyProperty

form_input_value_property_property = amplifyuibuilder.CfnForm.FormInputValuePropertyProperty(
    binding_properties=amplifyuibuilder.CfnForm.FormInputValuePropertyBindingPropertiesProperty(
        property="property",

        # the properties below are optional
        field="field"
    ),
    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 CfnForm.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 import aws_amplifyuibuilder as amplifyuibuilder

form_style_config_property = amplifyuibuilder.CfnForm.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 CfnForm.FormStyleProperty(*, horizontal_gap=None, outer_padding=None, vertical_gap=None)

Bases: object

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

Parameters:
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 import aws_amplifyuibuilder as amplifyuibuilder

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

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 CfnForm.SectionalElementProperty(*, type, excluded=None, level=None, orientation=None, position=None, text=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:

  • type (str) – The type of sectional element. Valid values are Heading , Text , and Divider .

  • 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.

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 import aws_amplifyuibuilder as amplifyuibuilder

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

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 CfnForm.ValueMappingProperty(*, value, display_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:
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 import aws_amplifyuibuilder as amplifyuibuilder

# form_input_value_property_property_: amplifyuibuilder.CfnForm.FormInputValuePropertyProperty

value_mapping_property = amplifyuibuilder.CfnForm.ValueMappingProperty(
    value=amplifyuibuilder.CfnForm.FormInputValuePropertyProperty(
        binding_properties=amplifyuibuilder.CfnForm.FormInputValuePropertyBindingPropertiesProperty(
            property="property",

            # the properties below are optional
            field="field"
        ),
        concat=[form_input_value_property_property_],
        value="value"
    ),

    # the properties below are optional
    display_value=amplifyuibuilder.CfnForm.FormInputValuePropertyProperty(
        binding_properties=amplifyuibuilder.CfnForm.FormInputValuePropertyBindingPropertiesProperty(
            property="property",

            # the properties below are optional
            field="field"
        ),
        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 CfnForm.ValueMappingsProperty(*, values, binding_properties=None)

Bases: object

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

Parameters:
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 import aws_amplifyuibuilder as amplifyuibuilder

# form_input_value_property_property_: amplifyuibuilder.CfnForm.FormInputValuePropertyProperty

value_mappings_property = amplifyuibuilder.CfnForm.ValueMappingsProperty(
    values=[amplifyuibuilder.CfnForm.ValueMappingProperty(
        value=amplifyuibuilder.CfnForm.FormInputValuePropertyProperty(
            binding_properties=amplifyuibuilder.CfnForm.FormInputValuePropertyBindingPropertiesProperty(
                property="property",

                # the properties below are optional
                field="field"
            ),
            concat=[form_input_value_property_property_],
            value="value"
        ),

        # the properties below are optional
        display_value=amplifyuibuilder.CfnForm.FormInputValuePropertyProperty(
            binding_properties=amplifyuibuilder.CfnForm.FormInputValuePropertyBindingPropertiesProperty(
                property="property",

                # the properties below are optional
                field="field"
            ),
            concat=[form_input_value_property_property_],
            value="value"
        )
    )],

    # the properties below are optional
    binding_properties={
        "binding_properties_key": amplifyuibuilder.CfnForm.FormInputBindingPropertiesValueProperty(
            binding_properties=amplifyuibuilder.CfnForm.FormInputBindingPropertiesValuePropertiesProperty(
                model="model"
            ),
            type="type"
        )
    }
)

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