1. Packages
  2. AWS Native
  3. API Docs
  4. amplifyuibuilder
  5. Form

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

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

aws-native.amplifyuibuilder.Form

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

    Definition of AWS::AmplifyUIBuilder::Form Resource Type

    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",
        },
    });
    
    Coming soon!
    

    Form Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Form resource accepts the following input properties:

    appId String
    cta FormCta
    dataType FormDataTypeConfig
    environmentName String
    fields Map<String,FormFieldConfigArgs>
    formActionType FormActionType
    labelDecorator FormLabelDecorator
    name String
    schemaVersion String
    sectionalElements Map<String,FormSectionalElementArgs>
    style FormStyle
    tags Map<String,String>
    appId string
    cta FormCta
    dataType FormDataTypeConfig
    environmentName string
    fields {[key: string]: FormFieldConfigArgs}
    formActionType FormActionType
    labelDecorator FormLabelDecorator
    name string
    schemaVersion string
    sectionalElements {[key: string]: FormSectionalElementArgs}
    style FormStyle
    tags {[key: string]: string}

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Form resource produces the following output properties:

    AwsId string
    Id string
    The provider-assigned unique ID for this managed resource.
    AwsId string
    Id string
    The provider-assigned unique ID for this managed resource.
    awsId String
    id String
    The provider-assigned unique ID for this managed resource.
    awsId string
    id string
    The provider-assigned unique ID for this managed resource.
    aws_id str
    id str
    The provider-assigned unique ID for this managed resource.
    awsId String
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    FormActionType, FormActionTypeArgs

    Create
    create
    Update
    update
    FormActionTypeCreate
    create
    FormActionTypeUpdate
    update
    Create
    create
    Update
    update
    Create
    create
    Update
    update
    CREATE
    create
    UPDATE
    update
    "create"
    create
    "update"
    update

    FormButton, FormButtonArgs

    FormButtonsPosition, FormButtonsPositionArgs

    Top
    top
    Bottom
    bottom
    TopAndBottom
    top_and_bottom
    FormButtonsPositionTop
    top
    FormButtonsPositionBottom
    bottom
    FormButtonsPositionTopAndBottom
    top_and_bottom
    Top
    top
    Bottom
    bottom
    TopAndBottom
    top_and_bottom
    Top
    top
    Bottom
    bottom
    TopAndBottom
    top_and_bottom
    TOP
    top
    BOTTOM
    bottom
    TOP_AND_BOTTOM
    top_and_bottom
    "top"
    top
    "bottom"
    bottom
    "top_and_bottom"
    top_and_bottom

    FormCta, FormCtaArgs

    FormDataSourceType, FormDataSourceTypeArgs

    DataStore
    DataStore
    Custom
    Custom
    FormDataSourceTypeDataStore
    DataStore
    FormDataSourceTypeCustom
    Custom
    DataStore
    DataStore
    Custom
    Custom
    DataStore
    DataStore
    Custom
    Custom
    DATA_STORE
    DataStore
    CUSTOM
    Custom
    "DataStore"
    DataStore
    "Custom"
    Custom

    FormDataTypeConfig, FormDataTypeConfigArgs

    FormFieldConfig, FormFieldConfigArgs

    FormFieldInputConfig, FormFieldInputConfigArgs

    FormFieldPosition0Properties, FormFieldPosition0PropertiesArgs

    FormFieldPosition1Properties, FormFieldPosition1PropertiesArgs

    RightOf string
    RightOf string
    rightOf String
    rightOf string
    rightOf String

    FormFieldPosition2Properties, FormFieldPosition2PropertiesArgs

    Below string
    Below string
    below String
    below string
    below str
    below String

    FormFieldValidationConfiguration, FormFieldValidationConfigurationArgs

    Type string
    NumValues List<double>
    StrValues List<string>
    ValidationMessage string
    Type string
    NumValues []float64
    StrValues []string
    ValidationMessage string
    type String
    numValues List<Double>
    strValues List<String>
    validationMessage String
    type string
    numValues number[]
    strValues string[]
    validationMessage string
    type str
    num_values Sequence[float]
    str_values Sequence[str]
    validation_message str
    type String
    numValues List<Number>
    strValues List<String>
    validationMessage String

    FormFileUploaderFieldConfig, FormFileUploaderFieldConfigArgs

    FormFixedPosition, FormFixedPositionArgs

    First
    first
    FormFixedPositionFirst
    first
    First
    first
    First
    first
    FIRST
    first
    "first"
    first

    FormInputBindingPropertiesValue, FormInputBindingPropertiesValueArgs

    FormInputBindingPropertiesValueProperties, FormInputBindingPropertiesValuePropertiesArgs

    Model string
    Model string
    model String
    model string
    model str
    model String

    FormInputValueProperty, FormInputValuePropertyArgs

    FormInputValuePropertyBindingProperties, FormInputValuePropertyBindingPropertiesArgs

    Property string
    Field string
    Property string
    Field string
    property String
    field String
    property string
    field string
    property String
    field String

    FormLabelDecorator, FormLabelDecoratorArgs

    Required
    required
    Optional
    optional
    None
    none
    FormLabelDecoratorRequired
    required
    FormLabelDecoratorOptional
    optional
    FormLabelDecoratorNone
    none
    Required
    required
    Optional
    optional
    None
    none
    Required
    required
    Optional
    optional
    None
    none
    REQUIRED
    required
    OPTIONAL
    optional
    NONE
    none
    "required"
    required
    "optional"
    optional
    "none"
    none

    FormSectionalElement, FormSectionalElementArgs

    FormStorageAccessLevel, FormStorageAccessLevelArgs

    Public
    public
    Protected
    protected
    Private
    private
    FormStorageAccessLevelPublic
    public
    FormStorageAccessLevelProtected
    protected
    FormStorageAccessLevelPrivate
    private
    Public
    public
    Protected
    protected
    Private
    private
    Public
    public
    Protected
    protected
    Private
    private
    PUBLIC
    public
    PROTECTED
    protected
    PRIVATE
    private
    "public"
    public
    "protected"
    protected
    "private"
    private

    FormStyle, FormStyleArgs

    FormStyleConfig0Properties, FormStyleConfig0PropertiesArgs

    FormStyleConfig1Properties, FormStyleConfig1PropertiesArgs

    Value string
    Value string
    value String
    value string
    value str
    value String

    FormValueMapping, FormValueMappingArgs

    FormValueMappings, FormValueMappingsArgs

    Values List<Pulumi.AwsNative.AmplifyUiBuilder.Inputs.FormValueMapping>
    BindingProperties Dictionary<string, Pulumi.AwsNative.AmplifyUiBuilder.Inputs.FormInputBindingPropertiesValue>
    Values []FormValueMapping
    BindingProperties map[string]FormInputBindingPropertiesValue
    values List<FormValueMapping>
    bindingProperties Map<String,FormInputBindingPropertiesValue>
    values FormValueMapping[]
    bindingProperties {[key: string]: FormInputBindingPropertiesValue}
    values Sequence[FormValueMapping]
    binding_properties Mapping[str, FormInputBindingPropertiesValue]

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

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

    AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi