Package software.amazon.awscdk.cfnpropertymixins.services.amplifyuibuilder

Class CfnFormPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.amplifyuibuilder.CfnFormPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.410Z")
@Stability(Stable)
public class CfnFormPropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::AmplifyUIBuilder::Form resource specifies all of the information that is required to create a form.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.amplifyuibuilder.*;
 import software.amazon.awscdk.*;
 FormInputValuePropertyProperty formInputValuePropertyProperty_;
 IMergeStrategy mergeStrategy;
 CfnFormPropsMixin cfnFormPropsMixin = CfnFormPropsMixin.Builder.create(CfnFormMixinProps.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()
                                 .defaultChecked(false)
                                 .defaultCountryCode("defaultCountryCode")
                                 .defaultValue("defaultValue")
                                 .descriptiveText("descriptiveText")
                                 .fileUploaderConfig(FileUploaderFieldConfigProperty.builder()
                                         .acceptedFileTypes(List.of("acceptedFileTypes"))
                                         .accessLevel("accessLevel")
                                         .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)
                                 .type("type")
                                 .value("value")
                                 .valueMappings(ValueMappingsProperty.builder()
                                         .bindingProperties(Map.of(
                                                 "bindingPropertiesKey", FormInputBindingPropertiesValueProperty.builder()
                                                         .bindingProperties(FormInputBindingPropertiesValuePropertiesProperty.builder()
                                                                 .model("model")
                                                                 .build())
                                                         .type("type")
                                                         .build()))
                                         .values(List.of(ValueMappingProperty.builder()
                                                 .displayValue(FormInputValuePropertyProperty.builder()
                                                         .bindingProperties(FormInputValuePropertyBindingPropertiesProperty.builder()
                                                                 .field("field")
                                                                 .property("property")
                                                                 .build())
                                                         .concat(List.of(formInputValuePropertyProperty_))
                                                         .value("value")
                                                         .build())
                                                 .value(FormInputValuePropertyProperty.builder()
                                                         .bindingProperties(FormInputValuePropertyBindingPropertiesProperty.builder()
                                                                 .field("field")
                                                                 .property("property")
                                                                 .build())
                                                         .concat(List.of(formInputValuePropertyProperty_))
                                                         .value("value")
                                                         .build())
                                                 .build()))
                                         .build())
                                 .build())
                         .label("label")
                         .position(FieldPositionProperty.builder()
                                 .below("below")
                                 .fixed("fixed")
                                 .rightOf("rightOf")
                                 .build())
                         .validations(List.of(FieldValidationConfigurationProperty.builder()
                                 .numValues(List.of(123))
                                 .strValues(List.of("strValues"))
                                 .type("type")
                                 .validationMessage("validationMessage")
                                 .build()))
                         .build()))
         .formActionType("formActionType")
         .labelDecorator("labelDecorator")
         .name("name")
         .schemaVersion("schemaVersion")
         .sectionalElements(Map.of(
                 "sectionalElementsKey", SectionalElementProperty.builder()
                         .excluded(false)
                         .level(123)
                         .orientation("orientation")
                         .position(FieldPositionProperty.builder()
                                 .below("below")
                                 .fixed("fixed")
                                 .rightOf("rightOf")
                                 .build())
                         .text("text")
                         .type("type")
                         .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())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnFormPropsMixin.Builder	A fluent builder for CfnFormPropsMixin.
static interface	CfnFormPropsMixin.FieldConfigProperty	The FieldConfig property specifies the configuration information for a field in a table.
static interface	CfnFormPropsMixin.FieldInputConfigProperty	The FieldInputConfig property specifies the configuration for the default input values to display for a field.
static interface	CfnFormPropsMixin.FieldPositionProperty	The FieldPosition property specifies the field position.
static interface	CfnFormPropsMixin.FieldValidationConfigurationProperty	The FieldValidationConfiguration property specifies the validation configuration for a field.
static interface	CfnFormPropsMixin.FileUploaderFieldConfigProperty	Describes the configuration for the file uploader field.
static interface	CfnFormPropsMixin.FormButtonProperty	The FormButton property specifies the configuration for a button UI element that is a part of a form.
static interface	CfnFormPropsMixin.FormCTAProperty	The FormCTA property specifies the call to action button configuration for the form.
static interface	CfnFormPropsMixin.FormDataTypeConfigProperty	The FormDataTypeConfig property specifies the data type configuration for the data source associated with a form.
static interface	CfnFormPropsMixin.FormInputBindingPropertiesValuePropertiesProperty	Represents the data binding configuration for a specific property using data stored in AWS .
static interface	CfnFormPropsMixin.FormInputBindingPropertiesValueProperty	Represents the data binding configuration for a form's input fields at runtime.You can use FormInputBindingPropertiesValue to add exposed properties to a form to allow different values to be entered when a form is reused in different places in an app.
static interface	CfnFormPropsMixin.FormInputValuePropertyBindingPropertiesProperty	Associates a form property to a binding property.
static interface	CfnFormPropsMixin.FormInputValuePropertyProperty	The FormInputValueProperty property specifies the configuration for an input field on a form.
static interface	CfnFormPropsMixin.FormStyleConfigProperty	The FormStyleConfig property specifies the configuration settings for the form's style properties.
static interface	CfnFormPropsMixin.FormStyleProperty	The FormStyle property specifies the configuration for the form's style.
static interface	CfnFormPropsMixin.SectionalElementProperty	The SectionalElement property specifies the configuration information for a visual helper element for a form.
static interface	CfnFormPropsMixin.ValueMappingProperty	The ValueMapping property specifies the association between a complex object and a display value.
static interface	CfnFormPropsMixin.ValueMappingsProperty	The ValueMappings property specifies the data binding configuration for a value map.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnFormPropsMixin(CfnFormMixinProps props)	Create a mixin to apply properties to AWS::AmplifyUIBuilder::Form.
	CfnFormPropsMixin(CfnFormMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::AmplifyUIBuilder::Form.
protected	CfnFormPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFormPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnFormMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnFormPropsMixin

protected CfnFormPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnFormPropsMixin

protected CfnFormPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnFormPropsMixin

@Stability(Stable)
public CfnFormPropsMixin(@NotNull
 CfnFormMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::AmplifyUIBuilder::Form.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnFormPropsMixin

@Stability(Stable)
public CfnFormPropsMixin(@NotNull
 CfnFormMixinProps props)

Create a mixin to apply properties to AWS::AmplifyUIBuilder::Form.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnFormMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()