aws-native.amplifyuibuilder.Form

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

pulumi/pulumi-aws-native

Create Form Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Form(name: string, args?: FormArgs, opts?: CustomResourceOptions);

@overload
def Form(resource_name: str,
         args: Optional[FormArgs] = None,
         opts: Optional[ResourceOptions] = None)

@overload
def Form(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         app_id: Optional[str] = None,
         cta: Optional[FormCtaArgs] = None,
         data_type: Optional[FormDataTypeConfigArgs] = None,
         environment_name: Optional[str] = None,
         fields: Optional[Mapping[str, FormFieldConfigArgs]] = None,
         form_action_type: Optional[FormActionType] = None,
         label_decorator: Optional[FormLabelDecorator] = None,
         name: Optional[str] = None,
         schema_version: Optional[str] = None,
         sectional_elements: Optional[Mapping[str, FormSectionalElementArgs]] = None,
         style: Optional[FormStyleArgs] = None,
         tags: Optional[Mapping[str, str]] = None)

func NewForm(ctx *Context, name string, args *FormArgs, opts ...ResourceOption) (*Form, error)

public Form(string name, FormArgs? args = null, CustomResourceOptions? opts = null)

public Form(String name, FormArgs args)
public Form(String name, FormArgs args, CustomResourceOptions options)

type: aws-native:amplifyuibuilder:Form
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args FormArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args FormArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args FormArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args FormArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args FormArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Example

The following reference example uses placeholder values for all input properties.

Coming soon!

Coming soon!

Coming soon!

Coming soon!

const formResource = new aws_native.amplifyuibuilder.Form("formResource", {
    appId: "string",
    cta: {
        cancel: {
            children: "string",
            excluded: false,
            position: {
                fixed: aws_native.amplifyuibuilder.FormFixedPosition.First,
            },
        },
        clear: {
            children: "string",
            excluded: false,
            position: {
                fixed: aws_native.amplifyuibuilder.FormFixedPosition.First,
            },
        },
        position: aws_native.amplifyuibuilder.FormButtonsPosition.Top,
        submit: {
            children: "string",
            excluded: false,
            position: {
                fixed: aws_native.amplifyuibuilder.FormFixedPosition.First,
            },
        },
    },
    dataType: {
        dataSourceType: aws_native.amplifyuibuilder.FormDataSourceType.DataStore,
        dataTypeName: "string",
    },
    environmentName: "string",
    fields: {
        string: {
            excluded: false,
            inputType: {
                type: "string",
                name: "string",
                placeholder: "string",
                descriptiveText: "string",
                fileUploaderConfig: {
                    acceptedFileTypes: ["string"],
                    accessLevel: aws_native.amplifyuibuilder.FormStorageAccessLevel.Public,
                    isResumable: false,
                    maxFileCount: 0,
                    maxSize: 0,
                    showThumbnails: false,
                },
                isArray: false,
                maxValue: 0,
                defaultValue: "string",
                defaultChecked: false,
                minValue: 0,
                readOnly: false,
                required: false,
                step: 0,
                defaultCountryCode: "string",
                value: "string",
                valueMappings: {
                    values: [{
                        value: {
                            bindingProperties: {
                                property: "string",
                                field: "string",
                            },
                            concat: [formInputValueProperty],
                            value: "string",
                        },
                        displayValue: formInputValueProperty,
                    }],
                    bindingProperties: {
                        string: {
                            bindingProperties: {
                                model: "string",
                            },
                            type: "string",
                        },
                    },
                },
            },
            label: "string",
            position: {
                fixed: aws_native.amplifyuibuilder.FormFixedPosition.First,
            },
            validations: [{
                type: "string",
                numValues: [0],
                strValues: ["string"],
                validationMessage: "string",
            }],
        },
    },
    formActionType: aws_native.amplifyuibuilder.FormActionType.Create,
    labelDecorator: aws_native.amplifyuibuilder.FormLabelDecorator.Required,
    name: "string",
    schemaVersion: "string",
    sectionalElements: {
        string: {
            type: "string",
            excluded: false,
            level: 0,
            orientation: "string",
            position: {
                fixed: aws_native.amplifyuibuilder.FormFixedPosition.First,
            },
            text: "string",
        },
    },
    style: {
        horizontalGap: {
            tokenReference: "string",
        },
        outerPadding: {
            tokenReference: "string",
        },
        verticalGap: {
            tokenReference: "string",
        },
    },
    tags: {
        string: "string",
    },
});