All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnFormProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-20T23:37:13.467Z") @Stability(Stable) public interface CfnFormProps extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnForm.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.amplifyuibuilder.*;
 FormInputValuePropertyProperty formInputValuePropertyProperty_;
 CfnFormProps cfnFormProps = CfnFormProps.builder()
         .appId("appId")
         .cta(FormCTAProperty.builder()
                 .cancel(FormButtonProperty.builder()
                         .children("children")
                         .excluded(false)
                         .position(FieldPositionProperty.builder()
                                 .below("below")
                                 .fixed("fixed")
                                 .rightOf("rightOf")
                                 .build())
                         .build())
                 .clear(FormButtonProperty.builder()
                         .children("children")
                         .excluded(false)
                         .position(FieldPositionProperty.builder()
                                 .below("below")
                                 .fixed("fixed")
                                 .rightOf("rightOf")
                                 .build())
                         .build())
                 .position("position")
                 .submit(FormButtonProperty.builder()
                         .children("children")
                         .excluded(false)
                         .position(FieldPositionProperty.builder()
                                 .below("below")
                                 .fixed("fixed")
                                 .rightOf("rightOf")
                                 .build())
                         .build())
                 .build())
         .dataType(FormDataTypeConfigProperty.builder()
                 .dataSourceType("dataSourceType")
                 .dataTypeName("dataTypeName")
                 .build())
         .environmentName("environmentName")
         .fields(Map.of(
                 "fieldsKey", FieldConfigProperty.builder()
                         .excluded(false)
                         .inputType(FieldInputConfigProperty.builder()
                                 .type("type")
                                 // the properties below are optional
                                 .defaultChecked(false)
                                 .defaultCountryCode("defaultCountryCode")
                                 .defaultValue("defaultValue")
                                 .descriptiveText("descriptiveText")
                                 .fileUploaderConfig(FileUploaderFieldConfigProperty.builder()
                                         .acceptedFileTypes(List.of("acceptedFileTypes"))
                                         .accessLevel("accessLevel")
                                         // the properties below are optional
                                         .isResumable(false)
                                         .maxFileCount(123)
                                         .maxSize(123)
                                         .showThumbnails(false)
                                         .build())
                                 .isArray(false)
                                 .maxValue(123)
                                 .minValue(123)
                                 .name("name")
                                 .placeholder("placeholder")
                                 .readOnly(false)
                                 .required(false)
                                 .step(123)
                                 .value("value")
                                 .valueMappings(ValueMappingsProperty.builder()
                                         .values(List.of(ValueMappingProperty.builder()
                                                 .value(FormInputValuePropertyProperty.builder()
                                                         .bindingProperties(FormInputValuePropertyBindingPropertiesProperty.builder()
                                                                 .property("property")
                                                                 // the properties below are optional
                                                                 .field("field")
                                                                 .build())
                                                         .concat(List.of(formInputValuePropertyProperty_))
                                                         .value("value")
                                                         .build())
                                                 // the properties below are optional
                                                 .displayValue(FormInputValuePropertyProperty.builder()
                                                         .bindingProperties(FormInputValuePropertyBindingPropertiesProperty.builder()
                                                                 .property("property")
                                                                 // the properties below are optional
                                                                 .field("field")
                                                                 .build())
                                                         .concat(List.of(formInputValuePropertyProperty_))
                                                         .value("value")
                                                         .build())
                                                 .build()))
                                         // the properties below are optional
                                         .bindingProperties(Map.of(
                                                 "bindingPropertiesKey", FormInputBindingPropertiesValueProperty.builder()
                                                         .bindingProperties(FormInputBindingPropertiesValuePropertiesProperty.builder()
                                                                 .model("model")
                                                                 .build())
                                                         .type("type")
                                                         .build()))
                                         .build())
                                 .build())
                         .label("label")
                         .position(FieldPositionProperty.builder()
                                 .below("below")
                                 .fixed("fixed")
                                 .rightOf("rightOf")
                                 .build())
                         .validations(List.of(FieldValidationConfigurationProperty.builder()
                                 .type("type")
                                 // the properties below are optional
                                 .numValues(List.of(123))
                                 .strValues(List.of("strValues"))
                                 .validationMessage("validationMessage")
                                 .build()))
                         .build()))
         .formActionType("formActionType")
         .labelDecorator("labelDecorator")
         .name("name")
         .schemaVersion("schemaVersion")
         .sectionalElements(Map.of(
                 "sectionalElementsKey", SectionalElementProperty.builder()
                         .type("type")
                         // the properties below are optional
                         .excluded(false)
                         .level(123)
                         .orientation("orientation")
                         .position(FieldPositionProperty.builder()
                                 .below("below")
                                 .fixed("fixed")
                                 .rightOf("rightOf")
                                 .build())
                         .text("text")
                         .build()))
         .style(FormStyleProperty.builder()
                 .horizontalGap(FormStyleConfigProperty.builder()
                         .tokenReference("tokenReference")
                         .value("value")
                         .build())
                 .outerPadding(FormStyleConfigProperty.builder()
                         .tokenReference("tokenReference")
                         .value("value")
                         .build())
                 .verticalGap(FormStyleConfigProperty.builder()
                         .tokenReference("tokenReference")
                         .value("value")
                         .build())
                 .build())
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnFormProps.Builder

A builder for CfnFormProps

static final class

CfnFormProps.Jsii$Proxy

An implementation for CfnFormProps
Method Summary

Modifier and Type

Method

Description

static CfnFormProps.Builder

builder()

default String

getAppId()

The unique ID of the Amplify app associated with the form.

default Object

getCta()

The FormCTA object that stores the call to action configuration for the form.

default Object

getDataType()

The type of data source to use to create the form.

default String

getEnvironmentName()

The name of the backend environment that is a part of the Amplify app.

default Object

getFields()

The configuration information for the form's fields.

default String

getFormActionType()

Specifies whether to perform a create or update action on the form.

default String

getLabelDecorator()

Specifies an icon or decoration to display on the form.

default String

getName()

The name of the form.

default String

getSchemaVersion()

The schema version of the form.

default Object

getSectionalElements()

The configuration information for the visual helper elements for the form.

default Object

getStyle()

The configuration for the form's style.

default Map<String,String>

getTags()

One or more key-value pairs to use when tagging the form data.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getAppId
  
  @Stability(Stable) @Nullable default String getAppId()
  
  The unique ID of the Amplify app associated with the form.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-appid
- getCta
  
  @Stability(Stable) @Nullable default Object getCta()
  
  The FormCTA object that stores the call to action configuration for the form.
  Returns union: either IResolvable or CfnForm.FormCTAProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-cta
- getDataType
  
  @Stability(Stable) @Nullable default Object getDataType()
  
  The type of data source to use to create the form.
  Returns union: either IResolvable or CfnForm.FormDataTypeConfigProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-datatype
- getEnvironmentName
  
  @Stability(Stable) @Nullable default String getEnvironmentName()
  
  The name of the backend environment that is a part of the Amplify app.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-environmentname
- getFields
  
  @Stability(Stable) @Nullable default Object getFields()
  
  The configuration information for the form's fields.
  Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnForm.FieldConfigProperty>
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-fields
- getFormActionType
  
  @Stability(Stable) @Nullable default String getFormActionType()
  
  Specifies whether to perform a create or update action on the form.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-formactiontype
- getLabelDecorator
  
  @Stability(Stable) @Nullable default String getLabelDecorator()
  
  Specifies an icon or decoration to display on the form.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-labeldecorator
- getName
  
  @Stability(Stable) @Nullable default String getName()
  
  The name of the form.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-name
- getSchemaVersion
  
  @Stability(Stable) @Nullable default String getSchemaVersion()
  
  The schema version of the form.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-schemaversion
- getSectionalElements
  
  @Stability(Stable) @Nullable default Object getSectionalElements()
  
  The configuration information for the visual helper elements for the form.
  These elements are not associated with any data.
  Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnForm.SectionalElementProperty>
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-sectionalelements
- getStyle
  
  @Stability(Stable) @Nullable default Object getStyle()
  
  The configuration for the form's style.
  Returns union: either IResolvable or CfnForm.FormStyleProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-style
- getTags
  
  @Stability(Stable) @Nullable default Map<String,String> getTags()
  
  One or more key-value pairs to use when tagging the form data.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-tags
- builder
  
  @Stability(Stable) static CfnFormProps.Builder builder()
  
  Returns:
  
  a CfnFormProps.Builder of CfnFormProps

Interface CfnFormProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getAppId

getCta

getDataType

getEnvironmentName

getFields

getFormActionType

getLabelDecorator

getName

getSchemaVersion

getSectionalElements

getStyle

getTags

builder