Package software.amazon.awscdk.services.amplifyuibuilder

Interface CfnFormProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFormProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:55.441Z")
@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.*;
 CfnFormProps cfnFormProps = CfnFormProps.builder()
         .dataType(FormDataTypeConfigProperty.builder()
                 .dataSourceType("dataSourceType")
                 .dataTypeName("dataTypeName")
                 .build())
         .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()
                                                         .value("value")
                                                         .build())
                                                 // the properties below are optional
                                                 .displayValue(FormInputValuePropertyProperty.builder()
                                                         .value("value")
                                                         .build())
                                                 .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")
         .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())
         // the properties below are optional
         .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())
         .environmentName("environmentName")
         .labelDecorator("labelDecorator")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

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.
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.
Object	getFields()	The configuration information for the form's fields.
String	getFormActionType()	Specifies whether to perform a create or update action on the form.
default String	getLabelDecorator()	AWS::AmplifyUIBuilder::Form.LabelDecorator.
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.
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

getDataType

@Stability(Stable)
@NotNull
Object getDataType()

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

getFields

@Stability(Stable)
@NotNull
Object getFields()

The configuration information for the form's fields.

getFormActionType

@Stability(Stable)
@NotNull
String getFormActionType()

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

getName

@Stability(Stable)
@NotNull
String getName()

The name of the form.

getSchemaVersion

@Stability(Stable)
@NotNull
String getSchemaVersion()

The schema version of the form.

getSectionalElements

@Stability(Stable)
@NotNull
Object getSectionalElements()

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

These elements are not associated with any data.

getStyle

@Stability(Stable)
@NotNull
Object getStyle()

The configuration for the form's style.

getAppId

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

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

getCta

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

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

getEnvironmentName

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

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

getLabelDecorator

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

AWS::AmplifyUIBuilder::Form.LabelDecorator.

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

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

builder

@Stability(Stable)
static CfnFormProps.Builder builder()

Returns:

a CfnFormProps.Builder of CfnFormProps