Package software.amazon.awscdk.services.amplifyuibuilder

Interface CfnForm.FieldConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnForm.FieldConfigProperty.Jsii$Proxy

Enclosing class:

CfnForm

@Stability(Stable)
public static interface CfnForm.FieldConfigProperty
extends software.amazon.jsii.JsiiSerializable

The FieldConfig property specifies the configuration information for a field in a table.

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_;
 FieldConfigProperty fieldConfigProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnForm.FieldConfigProperty.Builder	A builder for CfnForm.FieldConfigProperty
static final class	CfnForm.FieldConfigProperty.Jsii$Proxy	An implementation for CfnForm.FieldConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnForm.FieldConfigProperty.Builder	builder()
default Object	getExcluded()	Specifies whether to hide a field.
default Object	getInputType()	Describes the configuration for the default input value to display for a field.
default String	getLabel()	The label for the field.
default Object	getPosition()	Specifies the field position.
default Object	getValidations()	The validations to perform on the value in the field.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExcluded

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

Specifies whether to hide a field.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldconfig.html#cfn-amplifyuibuilder-form-fieldconfig-excluded

getInputType

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

Describes the configuration for the default input value to display for a field.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldconfig.html#cfn-amplifyuibuilder-form-fieldconfig-inputtype

getLabel

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

The label for the field.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldconfig.html#cfn-amplifyuibuilder-form-fieldconfig-label

getPosition

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

Specifies the field position.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldconfig.html#cfn-amplifyuibuilder-form-fieldconfig-position

getValidations

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

The validations to perform on the value in the field.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldconfig.html#cfn-amplifyuibuilder-form-fieldconfig-validations

builder

@Stability(Stable)
static CfnForm.FieldConfigProperty.Builder builder()

Returns:

a CfnForm.FieldConfigProperty.Builder of CfnForm.FieldConfigProperty