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

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 logo

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:

    AppId string
    EnvironmentName string
    Id string
    AppId string
    EnvironmentName string
    Id string
    appId String
    environmentName String
    id String
    appId string
    environmentName string
    id string
    appId String
    environmentName String
    id String

    getForm Result

    The following output properties are available:

    cta FormCta
    dataType FormDataTypeConfig
    fields Map<String,FormFieldConfig>
    formActionType FormActionType
    id String
    labelDecorator FormLabelDecorator
    name String
    schemaVersion String
    sectionalElements Map<String,FormSectionalElement>
    style FormStyle
    tags Map<String,String>
    cta FormCta
    dataType FormDataTypeConfig
    fields {[key: string]: FormFieldConfig}
    formActionType FormActionType
    id string
    labelDecorator FormLabelDecorator
    name string
    schemaVersion string
    sectionalElements {[key: string]: FormSectionalElement}
    style FormStyle
    tags {[key: string]: string}

    Supporting Types

    FormActionType

    FormButton

    FormButtonsPosition

    FormCta

    FormDataSourceType

    FormDataTypeConfig

    FormFieldConfig

    FormFieldInputConfig

    FormFieldPosition0Properties

    FormFieldPosition1Properties

    RightOf string
    RightOf string
    rightOf String
    rightOf string
    rightOf String

    FormFieldPosition2Properties

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

    FormFieldValidationConfiguration

    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

    FormFixedPosition

    FormInputBindingPropertiesValue

    FormInputBindingPropertiesValueProperties

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

    FormInputValueProperty

    FormInputValuePropertyBindingProperties

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

    FormLabelDecorator

    FormSectionalElement

    FormStorageAccessLevel

    FormStyle

    FormStyleConfig0Properties

    FormStyleConfig1Properties

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

    FormValueMapping

    FormValueMappings

    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.100.0 published on Wednesday, Mar 27, 2024 by Pulumi