AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.100.0 published on Wednesday, Mar 27, 2024 by Pulumi
aws-native.amplifyuibuilder.getForm
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.100.0 published on Wednesday, Mar 27, 2024 by Pulumi
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>
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]
func LookupForm(ctx *Context, args *LookupFormArgs, opts ...InvokeOption) (*LookupFormResult, error)
func LookupFormOutput(ctx *Context, args *LookupFormOutputArgs, opts ...InvokeOption) LookupFormResultOutput
> 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)
}
public static CompletableFuture<GetFormResult> getForm(GetFormArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:amplifyuibuilder:getForm
arguments:
# arguments dictionary
The following arguments are supported:
- App
Id string - Environment
Name string - Id string
- App
Id string - Environment
Name string - Id string
- app
Id String - environment
Name String - id String
- app
Id string - environment
Name string - id string
- app_
id str - environment_
name str - id str
- app
Id String - environment
Name String - id String
getForm Result
The following output properties are available:
- Cta
Pulumi.
Aws Native. Amplify Ui Builder. Outputs. Form Cta - Data
Type Pulumi.Aws Native. Amplify Ui Builder. Outputs. Form Data Type Config - Fields
Dictionary<string, Pulumi.
Aws Native. Amplify Ui Builder. Outputs. Form Field Config> - Form
Action Pulumi.Type Aws Native. Amplify Ui Builder. Form Action Type - Id string
- Label
Decorator Pulumi.Aws Native. Amplify Ui Builder. Form Label Decorator - Name string
- Schema
Version string - Sectional
Elements Dictionary<string, Pulumi.Aws Native. Amplify Ui Builder. Outputs. Form Sectional Element> - Style
Pulumi.
Aws Native. Amplify Ui Builder. Outputs. Form Style - Dictionary<string, string>
- Cta
Form
Cta - Data
Type FormData Type Config - Fields
map[string]Form
Field Config - Form
Action FormType Action Type - Id string
- Label
Decorator FormLabel Decorator - Name string
- Schema
Version string - Sectional
Elements map[string]FormSectional Element - Style
Form
Style - map[string]string
- cta
Form
Cta - data
Type FormData Type Config - fields
Map<String,Form
Field Config> - form
Action FormType Action Type - id String
- label
Decorator FormLabel Decorator - name String
- schema
Version String - sectional
Elements Map<String,FormSectional Element> - style
Form
Style - Map<String,String>
- cta
Form
Cta - data
Type FormData Type Config - fields
{[key: string]: Form
Field Config} - form
Action FormType Action Type - id string
- label
Decorator FormLabel Decorator - name string
- schema
Version string - sectional
Elements {[key: string]: FormSectional Element} - style
Form
Style - {[key: string]: string}
- cta
Form
Cta - data_
type FormData Type Config - fields
Mapping[str, Form
Field Config] - form_
action_ Formtype Action Type - id str
- label_
decorator FormLabel Decorator - name str
- schema_
version str - sectional_
elements Mapping[str, FormSectional Element] - style
Form
Style - Mapping[str, str]
- cta Property Map
- data
Type Property Map - fields Map<Property Map>
- form
Action "create" | "update"Type - id String
- label
Decorator "required" | "optional" | "none" - name String
- schema
Version String - sectional
Elements Map<Property Map> - style Property Map
- Map<String>
Supporting Types
FormActionType
FormButton
- children String
- excluded Boolean
- position Property Map | Property Map | Property Map
FormButtonsPosition
FormCta
FormDataSourceType
FormDataTypeConfig
FormFieldConfig
- Excluded bool
- Input
Type Pulumi.Aws Native. Amplify Ui Builder. Inputs. Form Field Input Config - Label string
- Position
Pulumi.
Aws | Pulumi.Native. Amplify Ui Builder. Inputs. Form Field Position0Properties Aws | Pulumi.Native. Amplify Ui Builder. Inputs. Form Field Position1Properties Aws Native. Amplify Ui Builder. Inputs. Form Field Position2Properties - Validations
List<Pulumi.
Aws Native. Amplify Ui Builder. Inputs. Form Field Validation Configuration>
FormFieldInputConfig
- Type string
- Default
Checked bool - Default
Country stringCode - Default
Value string - Descriptive
Text string - File
Uploader Pulumi.Config Aws Native. Amplify Ui Builder. Inputs. Form File Uploader Field Config - Is
Array bool - Max
Value double - Min
Value double - Name string
- Placeholder string
- Read
Only bool - Required bool
- Step double
- Value string
- Value
Mappings Pulumi.Aws Native. Amplify Ui Builder. Inputs. Form Value Mappings
- Type string
- Default
Checked bool - Default
Country stringCode - Default
Value string - Descriptive
Text string - File
Uploader FormConfig File Uploader Field Config - Is
Array bool - Max
Value float64 - Min
Value float64 - Name string
- Placeholder string
- Read
Only bool - Required bool
- Step float64
- Value string
- Value
Mappings FormValue Mappings
- type String
- default
Checked Boolean - default
Country StringCode - default
Value String - descriptive
Text String - file
Uploader FormConfig File Uploader Field Config - is
Array Boolean - max
Value Double - min
Value Double - name String
- placeholder String
- read
Only Boolean - required Boolean
- step Double
- value String
- value
Mappings FormValue Mappings
- type string
- default
Checked boolean - default
Country stringCode - default
Value string - descriptive
Text string - file
Uploader FormConfig File Uploader Field Config - is
Array boolean - max
Value number - min
Value number - name string
- placeholder string
- read
Only boolean - required boolean
- step number
- value string
- value
Mappings FormValue Mappings
- type str
- default_
checked bool - default_
country_ strcode - default_
value str - descriptive_
text str - file_
uploader_ Formconfig File Uploader Field Config - is_
array bool - max_
value float - min_
value float - name str
- placeholder str
- read_
only bool - required bool
- step float
- value str
- value_
mappings FormValue Mappings
- type String
- default
Checked Boolean - default
Country StringCode - default
Value String - descriptive
Text String - file
Uploader Property MapConfig - is
Array Boolean - max
Value Number - min
Value Number - name String
- placeholder String
- read
Only Boolean - required Boolean
- step Number
- value String
- value
Mappings Property Map
FormFieldPosition0Properties
FormFieldPosition1Properties
- Right
Of string
- Right
Of string
- right
Of String
- right
Of string
- right_
of str
- right
Of String
FormFieldPosition2Properties
- Below string
- Below string
- below String
- below string
- below str
- below String
FormFieldValidationConfiguration
- Type string
- Num
Values List<double> - Str
Values List<string> - Validation
Message string
- Type string
- Num
Values []float64 - Str
Values []string - Validation
Message string
- type String
- num
Values List<Double> - str
Values List<String> - validation
Message String
- type string
- num
Values number[] - str
Values string[] - validation
Message string
- type str
- num_
values Sequence[float] - str_
values Sequence[str] - validation_
message str
- type String
- num
Values List<Number> - str
Values List<String> - validation
Message String
FormFileUploaderFieldConfig
- Accepted
File List<string>Types - Access
Level Pulumi.Aws Native. Amplify Ui Builder. Form Storage Access Level - Is
Resumable bool - Max
File doubleCount - Max
Size double - Show
Thumbnails bool
- Accepted
File []stringTypes - Access
Level FormStorage Access Level - Is
Resumable bool - Max
File float64Count - Max
Size float64 - Show
Thumbnails bool
- accepted
File List<String>Types - access
Level FormStorage Access Level - is
Resumable Boolean - max
File DoubleCount - max
Size Double - show
Thumbnails Boolean
- accepted
File string[]Types - access
Level FormStorage Access Level - is
Resumable boolean - max
File numberCount - max
Size number - show
Thumbnails boolean
- accepted_
file_ Sequence[str]types - access_
level FormStorage Access Level - is_
resumable bool - max_
file_ floatcount - max_
size float - show_
thumbnails bool
- accepted
File List<String>Types - access
Level "public" | "protected" | "private" - is
Resumable Boolean - max
File NumberCount - max
Size Number - show
Thumbnails Boolean
FormFixedPosition
FormInputBindingPropertiesValue
FormInputBindingPropertiesValueProperties
- Model string
- Model string
- model String
- model string
- model str
- model String
FormInputValueProperty
FormInputValuePropertyBindingProperties
FormLabelDecorator
FormSectionalElement
- Type string
- Excluded bool
- Level float64
- Orientation string
- Position
Form
Field | FormPosition0Properties Field | FormPosition1Properties Field Position2Properties - Text string
- type String
- excluded Boolean
- level Double
- orientation String
- position
Form
Field | FormPosition0Properties Field | FormPosition1Properties Field Position2Properties - text String
- type string
- excluded boolean
- level number
- orientation string
- position
Form
Field | FormPosition0Properties Field | FormPosition1Properties Field Position2Properties - text string
- type String
- excluded Boolean
- level Number
- orientation String
- position Property Map | Property Map | Property Map
- text String
FormStorageAccessLevel
FormStyle
- Horizontal
Gap Pulumi.Aws | Pulumi.Native. Amplify Ui Builder. Inputs. Form Style Config0Properties Aws Native. Amplify Ui Builder. Inputs. Form Style Config1Properties - Outer
Padding Pulumi.Aws | Pulumi.Native. Amplify Ui Builder. Inputs. Form Style Config0Properties Aws Native. Amplify Ui Builder. Inputs. Form Style Config1Properties - Vertical
Gap Pulumi.Aws | Pulumi.Native. Amplify Ui Builder. Inputs. Form Style Config0Properties Aws Native. Amplify Ui Builder. Inputs. Form Style Config1Properties
FormStyleConfig0Properties
- Token
Reference string
- Token
Reference string
- token
Reference String
- token
Reference string
- token_
reference str
- token
Reference String
FormStyleConfig1Properties
- Value string
- Value string
- value String
- value string
- value str
- value String
FormValueMapping
FormValueMappings
- Values
List<Pulumi.
Aws Native. Amplify Ui Builder. Inputs. Form Value Mapping> - Binding
Properties Dictionary<string, Pulumi.Aws Native. Amplify Ui Builder. Inputs. Form Input Binding Properties Value>
- Values
[]Form
Value Mapping - Binding
Properties map[string]FormInput Binding Properties Value
- values
List<Form
Value Mapping> - binding
Properties Map<String,FormInput Binding Properties Value>
- values
Form
Value Mapping[] - binding
Properties {[key: string]: FormInput Binding Properties Value}
- values
Sequence[Form
Value Mapping] - binding_
properties Mapping[str, FormInput Binding Properties Value]
- values List<Property Map>
- binding
Properties Map<Property Map>
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.100.0 published on Wednesday, Mar 27, 2024 by Pulumi