Package software.amazon.awscdk.services.amplifyuibuilder

Class CfnForm

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.amplifyuibuilder.CfnForm

All Implemented Interfaces:

IInspectable, IFormRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-12-01T16:02:13.099Z")
@Stability(Stable)
public class CfnForm
extends CfnResource
implements IInspectable, IFormRef, ITaggable

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.services.amplifyuibuilder.*;
 FormInputValuePropertyProperty formInputValuePropertyProperty_;
 CfnForm cfnForm = CfnForm.Builder.create(this, "MyCfnForm")
         .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:

• 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	CfnForm.Builder	A fluent builder for CfnForm.
static interface	CfnForm.FieldConfigProperty	The FieldConfig property specifies the configuration information for a field in a table.
static interface	CfnForm.FieldInputConfigProperty	The FieldInputConfig property specifies the configuration for the default input values to display for a field.
static interface	CfnForm.FieldPositionProperty	The FieldPosition property specifies the field position.
static interface	CfnForm.FieldValidationConfigurationProperty	The FieldValidationConfiguration property specifies the validation configuration for a field.
static interface	CfnForm.FileUploaderFieldConfigProperty	Describes the configuration for the file uploader field.
static interface	CfnForm.FormButtonProperty	The FormButton property specifies the configuration for a button UI element that is a part of a form.
static interface	CfnForm.FormCTAProperty	The FormCTA property specifies the call to action button configuration for the form.
static interface	CfnForm.FormDataTypeConfigProperty	The FormDataTypeConfig property specifies the data type configuration for the data source associated with a form.
static interface	CfnForm.FormInputBindingPropertiesValuePropertiesProperty	Represents the data binding configuration for a specific property using data stored in AWS .
static interface	CfnForm.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	CfnForm.FormInputValuePropertyBindingPropertiesProperty	Associates a form property to a binding property.
static interface	CfnForm.FormInputValuePropertyProperty	The FormInputValueProperty property specifies the configuration for an input field on a form.
static interface	CfnForm.FormStyleConfigProperty	The FormStyleConfig property specifies the configuration settings for the form's style properties.
static interface	CfnForm.FormStyleProperty	The FormStyle property specifies the configuration for the form's style.
static interface	CfnForm.SectionalElementProperty	The SectionalElement property specifies the configuration information for a visual helper element for a form.
static interface	CfnForm.ValueMappingProperty	The ValueMapping property specifies the association between a complex object and a display value.
static interface	CfnForm.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.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.amplifyuibuilder.IFormRef

IFormRef.Jsii$Default, IFormRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnForm(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnForm(software.amazon.jsii.JsiiObjectRef objRef)
	CfnForm(software.constructs.Construct scope, String id)	Create a new AWS::AmplifyUIBuilder::Form.
	CfnForm(software.constructs.Construct scope, String id, CfnFormProps props)	Create a new AWS::AmplifyUIBuilder::Form.

Method Summary

Modifier and Type	Method	Description
String	getAppId()	The unique ID of the Amplify app associated with the form.
String	getAttrId()	The ID for the form.
protected Map<String,Object>	getCfnProperties()
Object	getCta()	The FormCTA object that stores the call to action configuration for the form.
Object	getDataType()	The type of data source to use to create the form.
String	getEnvironmentName()	The name of the backend environment that is a part of the Amplify app.
Object	getFields()	The configuration information for the form's fields.
String	getFormActionType()	Specifies whether to perform a create or update action on the form.
FormReference	getFormRef()	A reference to a Form resource.
String	getLabelDecorator()	Specifies an icon or decoration to display on the form.
String	getName()	The name of the form.
String	getSchemaVersion()	The schema version of the form.
Object	getSectionalElements()	The configuration information for the visual helper elements for the form.
Object	getStyle()	The configuration for the form's style.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
Map<String,String>	getTagsRaw()	One or more key-value pairs to use when tagging the form data.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnForm(Object x)	Checks whether the given object is a CfnForm.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAppId(String value)	The unique ID of the Amplify app associated with the form.
void	setCta(IResolvable value)	The FormCTA object that stores the call to action configuration for the form.
void	setCta(CfnForm.FormCTAProperty value)	The FormCTA object that stores the call to action configuration for the form.
void	setDataType(IResolvable value)	The type of data source to use to create the form.
void	setDataType(CfnForm.FormDataTypeConfigProperty value)	The type of data source to use to create the form.
void	setEnvironmentName(String value)	The name of the backend environment that is a part of the Amplify app.
void	setFields(Map<String,Object> value)	The configuration information for the form's fields.
void	setFields(IResolvable value)	The configuration information for the form's fields.
void	setFormActionType(String value)	Specifies whether to perform a create or update action on the form.
void	setLabelDecorator(String value)	Specifies an icon or decoration to display on the form.
void	setName(String value)	The name of the form.
void	setSchemaVersion(String value)	The schema version of the form.
void	setSectionalElements(Map<String,Object> value)	The configuration information for the visual helper elements for the form.
void	setSectionalElements(IResolvable value)	The configuration information for the visual helper elements for the form.
void	setStyle(IResolvable value)	The configuration for the form's style.
void	setStyle(CfnForm.FormStyleProperty value)	The configuration for the form's style.
void	setTagsRaw(Map<String,String> value)	One or more key-value pairs to use when tagging the form data.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnForm

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

CfnForm

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

CfnForm

@Stability(Stable)
public CfnForm(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnFormProps props)

Create a new AWS::AmplifyUIBuilder::Form.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties.

CfnForm

@Stability(Stable)
public CfnForm(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Create a new AWS::AmplifyUIBuilder::Form.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Method Details

isCfnForm

@Stability(Stable)
@NotNull
public static Boolean isCfnForm(@NotNull
 Object x)

Checks whether the given object is a CfnForm.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

The ID for the form.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getFormRef

@Stability(Stable)
@NotNull
public FormReference getFormRef()

A reference to a Form resource.

Specified by:

getFormRef in interface IFormRef

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getAppId

@Stability(Stable)
@Nullable
public String getAppId()

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

setAppId

@Stability(Stable)
public void setAppId(@Nullable
 String value)

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

getCta

@Stability(Stable)
@Nullable
public Object getCta()

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

Returns union: either IResolvable or CfnForm.FormCTAProperty

setCta

@Stability(Stable)
public void setCta(@Nullable
 IResolvable value)

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

setCta

@Stability(Stable)
public void setCta(@Nullable
 CfnForm.FormCTAProperty value)

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

getDataType

@Stability(Stable)
@Nullable
public Object getDataType()

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

Returns union: either IResolvable or CfnForm.FormDataTypeConfigProperty

setDataType

@Stability(Stable)
public void setDataType(@Nullable
 IResolvable value)

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

setDataType

@Stability(Stable)
public void setDataType(@Nullable
 CfnForm.FormDataTypeConfigProperty value)

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

getEnvironmentName

@Stability(Stable)
@Nullable
public String getEnvironmentName()

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

setEnvironmentName

@Stability(Stable)
public void setEnvironmentName(@Nullable
 String value)

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

getFields

@Stability(Stable)
@Nullable
public Object getFields()

The configuration information for the form's fields.

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnForm.FieldConfigProperty>

setFields

@Stability(Stable)
public void setFields(@Nullable
 IResolvable value)

The configuration information for the form's fields.

setFields

@Stability(Stable)
public void setFields(@Nullable
 Map<String,Object> value)

The configuration information for the form's fields.

getFormActionType

@Stability(Stable)
@Nullable
public String getFormActionType()

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

setFormActionType

@Stability(Stable)
public void setFormActionType(@Nullable
 String value)

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

getLabelDecorator

@Stability(Stable)
@Nullable
public String getLabelDecorator()

Specifies an icon or decoration to display on the form.

setLabelDecorator

@Stability(Stable)
public void setLabelDecorator(@Nullable
 String value)

Specifies an icon or decoration to display on the form.

getName

@Stability(Stable)
@Nullable
public String getName()

The name of the form.

setName

@Stability(Stable)
public void setName(@Nullable
 String value)

The name of the form.

getSchemaVersion

@Stability(Stable)
@Nullable
public String getSchemaVersion()

The schema version of the form.

setSchemaVersion

@Stability(Stable)
public void setSchemaVersion(@Nullable
 String value)

The schema version of the form.

getSectionalElements

@Stability(Stable)
@Nullable
public Object getSectionalElements()

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

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnForm.SectionalElementProperty>

setSectionalElements

@Stability(Stable)
public void setSectionalElements(@Nullable
 IResolvable value)

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

setSectionalElements

@Stability(Stable)
public void setSectionalElements(@Nullable
 Map<String,Object> value)

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

getStyle

@Stability(Stable)
@Nullable
public Object getStyle()

The configuration for the form's style.

Returns union: either IResolvable or CfnForm.FormStyleProperty

setStyle

@Stability(Stable)
public void setStyle(@Nullable
 IResolvable value)

The configuration for the form's style.

setStyle

@Stability(Stable)
public void setStyle(@Nullable
 CfnForm.FormStyleProperty value)

The configuration for the form's style.

getTagsRaw

@Stability(Stable)
@Nullable
public Map<String,String> getTagsRaw()

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

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 Map<String,String> value)

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