Package software.amazon.awscdk.services.amplifyuibuilder

Interface CfnForm.FieldInputConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnForm.FieldInputConfigProperty.Jsii$Proxy

Enclosing class:

CfnForm

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

The FieldInputConfig property specifies the configuration for the default input values to display for a field.

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_;
 FieldInputConfigProperty fieldInputConfigProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnForm.FieldInputConfigProperty.Builder	builder()
default Object	getDefaultChecked()	Specifies whether a field has a default value.
default String	getDefaultCountryCode()	The default country code for a phone number.
default String	getDefaultValue()	The default value for the field.
default String	getDescriptiveText()	The text to display to describe the field.
default Object	getFileUploaderConfig()	The configuration for the file uploader field.
default Object	getIsArray()	Specifies whether to render the field as an array.
default Number	getMaxValue()	The maximum value to display for the field.
default Number	getMinValue()	The minimum value to display for the field.
default String	getName()	The name of the field.
default String	getPlaceholder()	The text to display as a placeholder for the field.
default Object	getReadOnly()	Specifies a read only field.
default Object	getRequired()	Specifies a field that requires input.
default Number	getStep()	The stepping increment for a numeric value in a field.
String	getType()	The input type for the field.
default String	getValue()	The value for the field.
default Object	getValueMappings()	The information to use to customize the input fields with data at runtime.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getType

@Stability(Stable)
@NotNull
String getType()

The input type for the field.

See Also:

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

getDefaultChecked

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

Specifies whether a field has a default value.

Returns union: either Boolean or IResolvable

See Also:

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

getDefaultCountryCode

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

The default country code for a phone number.

See Also:

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

getDefaultValue

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

The default value for the field.

See Also:

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

getDescriptiveText

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

The text to display to describe the field.

See Also:

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

getFileUploaderConfig

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

The configuration for the file uploader field.

Returns union: either IResolvable or CfnForm.FileUploaderFieldConfigProperty

See Also:

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

getIsArray

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

Specifies whether to render the field as an array.

This property is ignored if the dataSourceType for the form is a Data Store.

Returns union: either Boolean or IResolvable

See Also:

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

getMaxValue

@Stability(Stable)
@Nullable
default Number getMaxValue()

The maximum value to display for the field.

See Also:

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

getMinValue

@Stability(Stable)
@Nullable
default Number getMinValue()

The minimum value to display for the field.

See Also:

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

getName

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

The name of the field.

See Also:

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

getPlaceholder

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

The text to display as a placeholder for the field.

See Also:

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

getReadOnly

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

Specifies a read only field.

Returns union: either Boolean or IResolvable

See Also:

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

getRequired

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

Specifies a field that requires input.

Returns union: either Boolean or IResolvable

See Also:

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

getStep

@Stability(Stable)
@Nullable
default Number getStep()

The stepping increment for a numeric value in a field.

See Also:

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

getValue

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

The value for the field.

See Also:

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

getValueMappings

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

The information to use to customize the input fields with data at runtime.

Returns union: either IResolvable or CfnForm.ValueMappingsProperty

See Also:

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

builder

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

Returns:

a CfnForm.FieldInputConfigProperty.Builder of CfnForm.FieldInputConfigProperty