Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. amplifyuibuilder
  5. getForm

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.amplifyuibuilder.getForm

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

Definition of AWS::AmplifyUIBuilder::Form Resource Type

Using getForm

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getForm(args: GetFormArgs, opts?: InvokeOptions): Promise<GetFormResult>
function getFormOutput(args: GetFormOutputArgs, opts?: InvokeOptions): Output<GetFormResult>
Copy
def get_form(app_id: Optional[str] = None,
             environment_name: Optional[str] = None,
             id: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetFormResult
def get_form_output(app_id: Optional[pulumi.Input[str]] = None,
             environment_name: Optional[pulumi.Input[str]] = None,
             id: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetFormResult]
Copy
func LookupForm(ctx *Context, args *LookupFormArgs, opts ...InvokeOption) (*LookupFormResult, error)
func LookupFormOutput(ctx *Context, args *LookupFormOutputArgs, opts ...InvokeOption) LookupFormResultOutput
Copy

> Note: This function is named LookupForm in the Go SDK.

public static class GetForm 
{
    public static Task<GetFormResult> InvokeAsync(GetFormArgs args, InvokeOptions? opts = null)
    public static Output<GetFormResult> Invoke(GetFormInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetFormResult> getForm(GetFormArgs args, InvokeOptions options)
public static Output<GetFormResult> getForm(GetFormArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:amplifyuibuilder:getForm
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AppId This property is required. string
The unique ID of the Amplify app associated with the form.
EnvironmentName This property is required. string
The name of the backend environment that is a part of the Amplify app.
Id This property is required. string
The ID for the form.
AppId This property is required. string
The unique ID of the Amplify app associated with the form.
EnvironmentName This property is required. string
The name of the backend environment that is a part of the Amplify app.
Id This property is required. string
The ID for the form.
appId This property is required. String
The unique ID of the Amplify app associated with the form.
environmentName This property is required. String
The name of the backend environment that is a part of the Amplify app.
id This property is required. String
The ID for the form.
appId This property is required. string
The unique ID of the Amplify app associated with the form.
environmentName This property is required. string
The name of the backend environment that is a part of the Amplify app.
id This property is required. string
The ID for the form.
app_id This property is required. str
The unique ID of the Amplify app associated with the form.
environment_name This property is required. str
The name of the backend environment that is a part of the Amplify app.
id This property is required. str
The ID for the form.
appId This property is required. String
The unique ID of the Amplify app associated with the form.
environmentName This property is required. String
The name of the backend environment that is a part of the Amplify app.
id This property is required. String
The ID for the form.

getForm Result

The following output properties are available:

Cta Pulumi.AwsNative.AmplifyUiBuilder.Outputs.FormCta
The FormCTA object that stores the call to action configuration for the form.
DataType Pulumi.AwsNative.AmplifyUiBuilder.Outputs.FormDataTypeConfig
The type of data source to use to create the form.
Fields Dictionary<string, Pulumi.AwsNative.AmplifyUiBuilder.Outputs.FormFieldConfig>
The configuration information for the form's fields.
FormActionType Pulumi.AwsNative.AmplifyUiBuilder.FormActionType
Specifies whether to perform a create or update action on the form.
Id string
The ID for the form.
LabelDecorator Pulumi.AwsNative.AmplifyUiBuilder.FormLabelDecorator
Specifies an icon or decoration to display on the form.
Name string
The name of the form.
SchemaVersion string
The schema version of the form.
SectionalElements Dictionary<string, Pulumi.AwsNative.AmplifyUiBuilder.Outputs.FormSectionalElement>
The configuration information for the visual helper elements for the form. These elements are not associated with any data.
Style Pulumi.AwsNative.AmplifyUiBuilder.Outputs.FormStyle
The configuration for the form's style.
Tags Dictionary<string, string>
One or more key-value pairs to use when tagging the form data.
Cta FormCta
The FormCTA object that stores the call to action configuration for the form.
DataType FormDataTypeConfig
The type of data source to use to create the form.
Fields map[string]FormFieldConfig
The configuration information for the form's fields.
FormActionType FormActionType
Specifies whether to perform a create or update action on the form.
Id string
The ID for the form.
LabelDecorator FormLabelDecorator
Specifies an icon or decoration to display on the form.
Name string
The name of the form.
SchemaVersion string
The schema version of the form.
SectionalElements map[string]FormSectionalElement
The configuration information for the visual helper elements for the form. These elements are not associated with any data.
Style FormStyle
The configuration for the form's style.
Tags map[string]string
One or more key-value pairs to use when tagging the form data.
cta FormCta
The FormCTA object that stores the call to action configuration for the form.
dataType FormDataTypeConfig
The type of data source to use to create the form.
fields Map<String,FormFieldConfig>
The configuration information for the form's fields.
formActionType FormActionType
Specifies whether to perform a create or update action on the form.
id String
The ID for the form.
labelDecorator FormLabelDecorator
Specifies an icon or decoration to display on the form.
name String
The name of the form.
schemaVersion String
The schema version of the form.
sectionalElements Map<String,FormSectionalElement>
The configuration information for the visual helper elements for the form. These elements are not associated with any data.
style FormStyle
The configuration for the form's style.
tags Map<String,String>
One or more key-value pairs to use when tagging the form data.
cta FormCta
The FormCTA object that stores the call to action configuration for the form.
dataType FormDataTypeConfig
The type of data source to use to create the form.
fields {[key: string]: FormFieldConfig}
The configuration information for the form's fields.
formActionType FormActionType
Specifies whether to perform a create or update action on the form.
id string
The ID for the form.
labelDecorator FormLabelDecorator
Specifies an icon or decoration to display on the form.
name string
The name of the form.
schemaVersion string
The schema version of the form.
sectionalElements {[key: string]: FormSectionalElement}
The configuration information for the visual helper elements for the form. These elements are not associated with any data.
style FormStyle
The configuration for the form's style.
tags {[key: string]: string}
One or more key-value pairs to use when tagging the form data.
cta FormCta
The FormCTA object that stores the call to action configuration for the form.
data_type FormDataTypeConfig
The type of data source to use to create the form.
fields Mapping[str, FormFieldConfig]
The configuration information for the form's fields.
form_action_type FormActionType
Specifies whether to perform a create or update action on the form.
id str
The ID for the form.
label_decorator FormLabelDecorator
Specifies an icon or decoration to display on the form.
name str
The name of the form.
schema_version str
The schema version of the form.
sectional_elements Mapping[str, FormSectionalElement]
The configuration information for the visual helper elements for the form. These elements are not associated with any data.
style FormStyle
The configuration for the form's style.
tags Mapping[str, str]
One or more key-value pairs to use when tagging the form data.
cta Property Map
The FormCTA object that stores the call to action configuration for the form.
dataType Property Map
The type of data source to use to create the form.
fields Map<Property Map>
The configuration information for the form's fields.
formActionType "create" | "update"
Specifies whether to perform a create or update action on the form.
id String
The ID for the form.
labelDecorator "required" | "optional" | "none"
Specifies an icon or decoration to display on the form.
name String
The name of the form.
schemaVersion String
The schema version of the form.
sectionalElements Map<Property Map>
The configuration information for the visual helper elements for the form. These elements are not associated with any data.
style Property Map
The configuration for the form's style.
tags Map<String>
One or more key-value pairs to use when tagging the form data.

Supporting Types

FormActionType

FormButton

Children string
Describes the button's properties.
Excluded bool
Specifies whether the button is visible on the form.
Position FormFieldPosition0Properties | FormFieldPosition1Properties | FormFieldPosition2Properties
The position of the button.
children String
Describes the button's properties.
excluded Boolean
Specifies whether the button is visible on the form.
position FormFieldPosition0Properties | FormFieldPosition1Properties | FormFieldPosition2Properties
The position of the button.
children string
Describes the button's properties.
excluded boolean
Specifies whether the button is visible on the form.
position FormFieldPosition0Properties | FormFieldPosition1Properties | FormFieldPosition2Properties
The position of the button.
children str
Describes the button's properties.
excluded bool
Specifies whether the button is visible on the form.
position FormFieldPosition0Properties | FormFieldPosition1Properties | FormFieldPosition2Properties
The position of the button.
children String
Describes the button's properties.
excluded Boolean
Specifies whether the button is visible on the form.
position Property Map | Property Map | Property Map
The position of the button.

FormButtonsPosition

FormCta

Cancel FormButton
Displays a cancel button.
Clear FormButton
Displays a clear button.
Position FormButtonsPosition
The position of the button.
Submit FormButton
Displays a submit button.
cancel FormButton
Displays a cancel button.
clear FormButton
Displays a clear button.
position FormButtonsPosition
The position of the button.
submit FormButton
Displays a submit button.
cancel FormButton
Displays a cancel button.
clear FormButton
Displays a clear button.
position FormButtonsPosition
The position of the button.
submit FormButton
Displays a submit button.
cancel FormButton
Displays a cancel button.
clear FormButton
Displays a clear button.
position FormButtonsPosition
The position of the button.
submit FormButton
Displays a submit button.
cancel Property Map
Displays a cancel button.
clear Property Map
Displays a clear button.
position "top" | "bottom" | "top_and_bottom"
The position of the button.
submit Property Map
Displays a submit button.

FormDataSourceType

FormDataTypeConfig

DataSourceType This property is required. Pulumi.AwsNative.AmplifyUiBuilder.FormDataSourceType
The data source type, either an Amplify DataStore model or a custom data type.
DataTypeName This property is required. string
The unique name of the data type you are using as the data source for the form.
DataSourceType This property is required. FormDataSourceType
The data source type, either an Amplify DataStore model or a custom data type.
DataTypeName This property is required. string
The unique name of the data type you are using as the data source for the form.
dataSourceType This property is required. FormDataSourceType
The data source type, either an Amplify DataStore model or a custom data type.
dataTypeName This property is required. String
The unique name of the data type you are using as the data source for the form.
dataSourceType This property is required. FormDataSourceType
The data source type, either an Amplify DataStore model or a custom data type.
dataTypeName This property is required. string
The unique name of the data type you are using as the data source for the form.
data_source_type This property is required. FormDataSourceType
The data source type, either an Amplify DataStore model or a custom data type.
data_type_name This property is required. str
The unique name of the data type you are using as the data source for the form.
dataSourceType This property is required. "DataStore" | "Custom"
The data source type, either an Amplify DataStore model or a custom data type.
dataTypeName This property is required. String
The unique name of the data type you are using as the data source for the form.

FormFieldConfig

Excluded bool
Specifies whether to hide a field.
InputType FormFieldInputConfig
Describes the configuration for the default input value to display for a field.
Label string
The label for the field.
Position FormFieldPosition0Properties | FormFieldPosition1Properties | FormFieldPosition2Properties
Specifies the field position.
Validations []FormFieldValidationConfiguration
The validations to perform on the value in the field.
excluded Boolean
Specifies whether to hide a field.
inputType FormFieldInputConfig
Describes the configuration for the default input value to display for a field.
label String
The label for the field.
position FormFieldPosition0Properties | FormFieldPosition1Properties | FormFieldPosition2Properties
Specifies the field position.
validations List<FormFieldValidationConfiguration>
The validations to perform on the value in the field.
excluded boolean
Specifies whether to hide a field.
inputType FormFieldInputConfig
Describes the configuration for the default input value to display for a field.
label string
The label for the field.
position FormFieldPosition0Properties | FormFieldPosition1Properties | FormFieldPosition2Properties
Specifies the field position.
validations FormFieldValidationConfiguration[]
The validations to perform on the value in the field.
excluded bool
Specifies whether to hide a field.
input_type FormFieldInputConfig
Describes the configuration for the default input value to display for a field.
label str
The label for the field.
position FormFieldPosition0Properties | FormFieldPosition1Properties | FormFieldPosition2Properties
Specifies the field position.
validations Sequence[FormFieldValidationConfiguration]
The validations to perform on the value in the field.
excluded Boolean
Specifies whether to hide a field.
inputType Property Map
Describes the configuration for the default input value to display for a field.
label String
The label for the field.
position Property Map | Property Map | Property Map
Specifies the field position.
validations List<Property Map>
The validations to perform on the value in the field.

FormFieldInputConfig

Type This property is required. string
The input type for the field.
DefaultChecked bool
Specifies whether a field has a default value.
DefaultCountryCode string
The default country code for a phone number.
DefaultValue string
The default value for the field.
DescriptiveText string
The text to display to describe the field.
FileUploaderConfig Pulumi.AwsNative.AmplifyUiBuilder.Inputs.FormFileUploaderFieldConfig
The configuration for the file uploader field.
IsArray bool
Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.
MaxValue double
The maximum value to display for the field.
MinValue double
The minimum value to display for the field.
Name string
The name of the field.
Placeholder string
The text to display as a placeholder for the field.
ReadOnly bool
Specifies a read only field.
Required bool
Specifies a field that requires input.
Step double
The stepping increment for a numeric value in a field.
Value string
The value for the field.
ValueMappings Pulumi.AwsNative.AmplifyUiBuilder.Inputs.FormValueMappings
The information to use to customize the input fields with data at runtime.
Type This property is required. string
The input type for the field.
DefaultChecked bool
Specifies whether a field has a default value.
DefaultCountryCode string
The default country code for a phone number.
DefaultValue string
The default value for the field.
DescriptiveText string
The text to display to describe the field.
FileUploaderConfig FormFileUploaderFieldConfig
The configuration for the file uploader field.
IsArray bool
Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.
MaxValue float64
The maximum value to display for the field.
MinValue float64
The minimum value to display for the field.
Name string
The name of the field.
Placeholder string
The text to display as a placeholder for the field.
ReadOnly bool
Specifies a read only field.
Required bool
Specifies a field that requires input.
Step float64
The stepping increment for a numeric value in a field.
Value string
The value for the field.
ValueMappings FormValueMappings
The information to use to customize the input fields with data at runtime.
type This property is required. String
The input type for the field.
defaultChecked Boolean
Specifies whether a field has a default value.
defaultCountryCode String
The default country code for a phone number.
defaultValue String
The default value for the field.
descriptiveText String
The text to display to describe the field.
fileUploaderConfig FormFileUploaderFieldConfig
The configuration for the file uploader field.
isArray Boolean
Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.
maxValue Double
The maximum value to display for the field.
minValue Double
The minimum value to display for the field.
name String
The name of the field.
placeholder String
The text to display as a placeholder for the field.
readOnly Boolean
Specifies a read only field.
required Boolean
Specifies a field that requires input.
step Double
The stepping increment for a numeric value in a field.
value String
The value for the field.
valueMappings FormValueMappings
The information to use to customize the input fields with data at runtime.
type This property is required. string
The input type for the field.
defaultChecked boolean
Specifies whether a field has a default value.
defaultCountryCode string
The default country code for a phone number.
defaultValue string
The default value for the field.
descriptiveText string
The text to display to describe the field.
fileUploaderConfig FormFileUploaderFieldConfig
The configuration for the file uploader field.
isArray boolean
Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.
maxValue number
The maximum value to display for the field.
minValue number
The minimum value to display for the field.
name string
The name of the field.
placeholder string
The text to display as a placeholder for the field.
readOnly boolean
Specifies a read only field.
required boolean
Specifies a field that requires input.
step number
The stepping increment for a numeric value in a field.
value string
The value for the field.
valueMappings FormValueMappings
The information to use to customize the input fields with data at runtime.
type This property is required. str
The input type for the field.
default_checked bool
Specifies whether a field has a default value.
default_country_code str
The default country code for a phone number.
default_value str
The default value for the field.
descriptive_text str
The text to display to describe the field.
file_uploader_config FormFileUploaderFieldConfig
The configuration for the file uploader field.
is_array bool
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 float
The maximum value to display for the field.
min_value float
The minimum value to display for the field.
name str
The name of the field.
placeholder str
The text to display as a placeholder for the field.
read_only bool
Specifies a read only field.
required bool
Specifies a field that requires input.
step float
The stepping increment for a numeric value in a field.
value str
The value for the field.
value_mappings FormValueMappings
The information to use to customize the input fields with data at runtime.
type This property is required. String
The input type for the field.
defaultChecked Boolean
Specifies whether a field has a default value.
defaultCountryCode String
The default country code for a phone number.
defaultValue String
The default value for the field.
descriptiveText String
The text to display to describe the field.
fileUploaderConfig Property Map
The configuration for the file uploader field.
isArray Boolean
Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.
maxValue Number
The maximum value to display for the field.
minValue Number
The minimum value to display for the field.
name String
The name of the field.
placeholder String
The text to display as a placeholder for the field.
readOnly Boolean
Specifies a read only field.
required Boolean
Specifies a field that requires input.
step Number
The stepping increment for a numeric value in a field.
value String
The value for the field.
valueMappings Property Map
The information to use to customize the input fields with data at runtime.

FormFieldPosition0Properties

Fixed This property is required. FormFixedPosition
fixed This property is required. FormFixedPosition
fixed This property is required. FormFixedPosition
fixed This property is required. FormFixedPosition
fixed This property is required. "first"

FormFieldPosition1Properties

RightOf This property is required. string
RightOf This property is required. string
rightOf This property is required. String
rightOf This property is required. string
right_of This property is required. str
rightOf This property is required. String

FormFieldPosition2Properties

Below This property is required. string
Below This property is required. string
below This property is required. String
below This property is required. string
below This property is required. str
below This property is required. String

FormFieldValidationConfiguration

Type This property is required. string
The validation to perform on an object type. ``
NumValues List<double>
The validation to perform on a number value.
StrValues List<string>
The validation to perform on a string value.
ValidationMessage string
The validation message to display.
Type This property is required. string
The validation to perform on an object type. ``
NumValues []float64
The validation to perform on a number value.
StrValues []string
The validation to perform on a string value.
ValidationMessage string
The validation message to display.
type This property is required. String
The validation to perform on an object type. ``
numValues List<Double>
The validation to perform on a number value.
strValues List<String>
The validation to perform on a string value.
validationMessage String
The validation message to display.
type This property is required. string
The validation to perform on an object type. ``
numValues number[]
The validation to perform on a number value.
strValues string[]
The validation to perform on a string value.
validationMessage string
The validation message to display.
type This property is required. str
The validation to perform on an object type. ``
num_values Sequence[float]
The validation to perform on a number value.
str_values Sequence[str]
The validation to perform on a string value.
validation_message str
The validation message to display.
type This property is required. String
The validation to perform on an object type. ``
numValues List<Number>
The validation to perform on a number value.
strValues List<String>
The validation to perform on a string value.
validationMessage String
The validation message to display.

FormFileUploaderFieldConfig

AcceptedFileTypes This property is required. List<string>
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.
AccessLevel This property is required. Pulumi.AwsNative.AmplifyUiBuilder.FormStorageAccessLevel
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 .
IsResumable bool

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.

MaxFileCount double
Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.
MaxSize double
The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.
ShowThumbnails bool
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.
AcceptedFileTypes This property is required. []string
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.
AccessLevel This property is required. FormStorageAccessLevel
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 .
IsResumable bool

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.

MaxFileCount float64
Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.
MaxSize float64
The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.
ShowThumbnails bool
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.
acceptedFileTypes This property is required. List<String>
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.
accessLevel This property is required. FormStorageAccessLevel
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 .
isResumable Boolean

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.

maxFileCount Double
Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.
maxSize Double
The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.
showThumbnails Boolean
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.
acceptedFileTypes This property is required. string[]
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.
accessLevel This property is required. FormStorageAccessLevel
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 .
isResumable boolean

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.

maxFileCount number
Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.
maxSize number
The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.
showThumbnails boolean
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.
accepted_file_types This property is required. 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 This property is required. FormStorageAccessLevel
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 bool

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 float
Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.
max_size float
The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.
show_thumbnails bool
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.
acceptedFileTypes This property is required. List<String>
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.
accessLevel This property is required. "public" | "protected" | "private"
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 .
isResumable Boolean

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.

maxFileCount Number
Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.
maxSize Number
The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.
showThumbnails Boolean
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.

FormFixedPosition

FormInputBindingPropertiesValue

BindingProperties Pulumi.AwsNative.AmplifyUiBuilder.Inputs.FormInputBindingPropertiesValueProperties
Describes the properties to customize with data at runtime.
Type string
The property type.
BindingProperties FormInputBindingPropertiesValueProperties
Describes the properties to customize with data at runtime.
Type string
The property type.
bindingProperties FormInputBindingPropertiesValueProperties
Describes the properties to customize with data at runtime.
type String
The property type.
bindingProperties FormInputBindingPropertiesValueProperties
Describes the properties to customize with data at runtime.
type string
The property type.
binding_properties FormInputBindingPropertiesValueProperties
Describes the properties to customize with data at runtime.
type str
The property type.
bindingProperties Property Map
Describes the properties to customize with data at runtime.
type String
The property type.

FormInputBindingPropertiesValueProperties

Model string
An Amplify DataStore model.
Model string
An Amplify DataStore model.
model String
An Amplify DataStore model.
model string
An Amplify DataStore model.
model str
An Amplify DataStore model.
model String
An Amplify DataStore model.

FormInputValueProperty

BindingProperties Pulumi.AwsNative.AmplifyUiBuilder.Inputs.FormInputValuePropertyBindingProperties
The information to bind fields to data at runtime.
Concat List<Pulumi.AwsNative.AmplifyUiBuilder.Inputs.FormInputValueProperty>
A list of form properties to concatenate to create the value to assign to this field property.
Value string
The value to assign to the input field.
BindingProperties FormInputValuePropertyBindingProperties
The information to bind fields to data at runtime.
Concat []FormInputValueProperty
A list of form properties to concatenate to create the value to assign to this field property.
Value string
The value to assign to the input field.
bindingProperties FormInputValuePropertyBindingProperties
The information to bind fields to data at runtime.
concat List<FormInputValueProperty>
A list of form properties to concatenate to create the value to assign to this field property.
value String
The value to assign to the input field.
bindingProperties FormInputValuePropertyBindingProperties
The information to bind fields to data at runtime.
concat FormInputValueProperty[]
A list of form properties to concatenate to create the value to assign to this field property.
value string
The value to assign to the input field.
binding_properties FormInputValuePropertyBindingProperties
The information to bind fields to data at runtime.
concat Sequence[FormInputValueProperty]
A list of form properties to concatenate to create the value to assign to this field property.
value str
The value to assign to the input field.
bindingProperties Property Map
The information to bind fields to data at runtime.
concat List<Property Map>
A list of form properties to concatenate to create the value to assign to this field property.
value String
The value to assign to the input field.

FormInputValuePropertyBindingProperties

Property This property is required. string
The form property to bind to the data field.
Field string
The data field to bind the property to.
Property This property is required. string
The form property to bind to the data field.
Field string
The data field to bind the property to.
property This property is required. String
The form property to bind to the data field.
field String
The data field to bind the property to.
property This property is required. string
The form property to bind to the data field.
field string
The data field to bind the property to.
property This property is required. str
The form property to bind to the data field.
field str
The data field to bind the property to.
property This property is required. String
The form property to bind to the data field.
field String
The data field to bind the property to.

FormLabelDecorator

FormSectionalElement

Type This property is required. string
The type of sectional element. Valid values are Heading , Text , and Divider .
Excluded bool
Excludes a sectional element that was generated by default for a specified data model.
Level double
Specifies the size of the font for a Heading sectional element. Valid values are 1 | 2 | 3 | 4 | 5 | 6 .
Orientation string
Specifies the orientation for a Divider sectional element. Valid values are horizontal or vertical .
Position Pulumi.AwsNative.AmplifyUiBuilder.Inputs.FormFieldPosition0Properties | Pulumi.AwsNative.AmplifyUiBuilder.Inputs.FormFieldPosition1Properties | Pulumi.AwsNative.AmplifyUiBuilder.Inputs.FormFieldPosition2Properties
Specifies the position of the text in a field for a Text sectional element.
Text string
The text for a Text sectional element.
Type This property is required. string
The type of sectional element. Valid values are Heading , Text , and Divider .
Excluded bool
Excludes a sectional element that was generated by default for a specified data model.
Level float64
Specifies the size of the font for a Heading sectional element. Valid values are 1 | 2 | 3 | 4 | 5 | 6 .
Orientation string
Specifies the orientation for a Divider sectional element. Valid values are horizontal or vertical .
Position FormFieldPosition0Properties | FormFieldPosition1Properties | FormFieldPosition2Properties
Specifies the position of the text in a field for a Text sectional element.
Text string
The text for a Text sectional element.
type This property is required. String
The type of sectional element. Valid values are Heading , Text , and Divider .
excluded Boolean
Excludes a sectional element that was generated by default for a specified data model.
level Double
Specifies the size of the font for a Heading sectional element. Valid values are 1 | 2 | 3 | 4 | 5 | 6 .
orientation String
Specifies the orientation for a Divider sectional element. Valid values are horizontal or vertical .
position FormFieldPosition0Properties | FormFieldPosition1Properties | FormFieldPosition2Properties
Specifies the position of the text in a field for a Text sectional element.
text String
The text for a Text sectional element.
type This property is required. string
The type of sectional element. Valid values are Heading , Text , and Divider .
excluded boolean
Excludes a sectional element that was generated by default for a specified data model.
level number
Specifies the size of the font for a Heading sectional element. Valid values are 1 | 2 | 3 | 4 | 5 | 6 .
orientation string
Specifies the orientation for a Divider sectional element. Valid values are horizontal or vertical .
position FormFieldPosition0Properties | FormFieldPosition1Properties | FormFieldPosition2Properties
Specifies the position of the text in a field for a Text sectional element.
text string
The text for a Text sectional element.
type This property is required. str
The type of sectional element. Valid values are Heading , Text , and Divider .
excluded bool
Excludes a sectional element that was generated by default for a specified data model.
level float
Specifies the size of the font for a Heading sectional element. Valid values are 1 | 2 | 3 | 4 | 5 | 6 .
orientation str
Specifies the orientation for a Divider sectional element. Valid values are horizontal or vertical .
position FormFieldPosition0Properties | FormFieldPosition1Properties | FormFieldPosition2Properties
Specifies the position of the text in a field for a Text sectional element.
text str
The text for a Text sectional element.
type This property is required. String
The type of sectional element. Valid values are Heading , Text , and Divider .
excluded Boolean
Excludes a sectional element that was generated by default for a specified data model.
level Number
Specifies the size of the font for a Heading sectional element. Valid values are 1 | 2 | 3 | 4 | 5 | 6 .
orientation String
Specifies the orientation for a Divider sectional element. Valid values are horizontal or vertical .
position Property Map | Property Map | Property Map
Specifies the position of the text in a field for a Text sectional element.
text String
The text for a Text sectional element.

FormStorageAccessLevel

FormStyle

horizontalGap Property Map | Property Map
The spacing for the horizontal gap.
outerPadding Property Map | Property Map
The size of the outer padding for the form.
verticalGap Property Map | Property Map
The spacing for the vertical gap.

FormStyleConfig0Properties

TokenReference This property is required. string
TokenReference This property is required. string
tokenReference This property is required. String
tokenReference This property is required. string
token_reference This property is required. str
tokenReference This property is required. String

FormStyleConfig1Properties

Value This property is required. string
Value This property is required. string
value This property is required. String
value This property is required. string
value This property is required. str
value This property is required. String

FormValueMapping

Value This property is required. FormInputValueProperty
The complex object.
DisplayValue FormInputValueProperty
The value to display for the complex object.
value This property is required. FormInputValueProperty
The complex object.
displayValue FormInputValueProperty
The value to display for the complex object.
value This property is required. FormInputValueProperty
The complex object.
displayValue FormInputValueProperty
The value to display for the complex object.
value This property is required. FormInputValueProperty
The complex object.
display_value FormInputValueProperty
The value to display for the complex object.
value This property is required. Property Map
The complex object.
displayValue Property Map
The value to display for the complex object.

FormValueMappings

Values This property is required. List<Pulumi.AwsNative.AmplifyUiBuilder.Inputs.FormValueMapping>
The value and display value pairs.
BindingProperties Dictionary<string, Pulumi.AwsNative.AmplifyUiBuilder.Inputs.FormInputBindingPropertiesValue>
The information to bind fields to data at runtime.
Values This property is required. []FormValueMapping
The value and display value pairs.
BindingProperties map[string]FormInputBindingPropertiesValue
The information to bind fields to data at runtime.
values This property is required. List<FormValueMapping>
The value and display value pairs.
bindingProperties Map<String,FormInputBindingPropertiesValue>
The information to bind fields to data at runtime.
values This property is required. FormValueMapping[]
The value and display value pairs.
bindingProperties {[key: string]: FormInputBindingPropertiesValue}
The information to bind fields to data at runtime.
values This property is required. Sequence[FormValueMapping]
The value and display value pairs.
binding_properties Mapping[str, FormInputBindingPropertiesValue]
The information to bind fields to data at runtime.
values This property is required. List<Property Map>
The value and display value pairs.
bindingProperties Map<Property Map>
The information to bind fields to data at runtime.

Package Details

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

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native