FieldInputConfigProperty Struct
The FieldInputConfig property specifies the configuration for the default input values to display for a field.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_amplifyuibuilder as amplifyuibuilder } from 'aws-cdk-lib';
declare const formInputValuePropertyProperty_: amplifyuibuilder.CfnForm.FormInputValuePropertyProperty;
const fieldInputConfigProperty: amplifyuibuilder.CfnForm.FieldInputConfigProperty = {
type: 'type',
// the properties below are optional
defaultChecked: false,
defaultCountryCode: 'defaultCountryCode',
defaultValue: 'defaultValue',
descriptiveText: 'descriptiveText',
fileUploaderConfig: {
acceptedFileTypes: ['acceptedFileTypes'],
accessLevel: 'accessLevel',
// the properties below are optional
isResumable: false,
maxFileCount: 123,
maxSize: 123,
showThumbnails: false,
},
isArray: false,
maxValue: 123,
minValue: 123,
name: 'name',
placeholder: 'placeholder',
readOnly: false,
required: false,
step: 123,
value: 'value',
valueMappings: {
values: [{
value: {
bindingProperties: {
property: 'property',
// the properties below are optional
field: 'field',
},
concat: [formInputValuePropertyProperty_],
value: 'value',
},
// the properties below are optional
displayValue: {
bindingProperties: {
property: 'property',
// the properties below are optional
field: 'field',
},
concat: [formInputValuePropertyProperty_],
value: 'value',
},
}],
// the properties below are optional
bindingProperties: {
bindingPropertiesKey: {
bindingProperties: {
model: 'model',
},
type: 'type',
},
},
},
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_amplifyuibuilder as amplifyuibuilder
# form_input_value_property_property_: amplifyuibuilder.CfnForm.FormInputValuePropertyProperty
field_input_config_property = amplifyuibuilder.CfnForm.FieldInputConfigProperty(
type="type",
# the properties below are optional
default_checked=False,
default_country_code="defaultCountryCode",
default_value="defaultValue",
descriptive_text="descriptiveText",
file_uploader_config=amplifyuibuilder.CfnForm.FileUploaderFieldConfigProperty(
accepted_file_types=["acceptedFileTypes"],
access_level="accessLevel",
# the properties below are optional
is_resumable=False,
max_file_count=123,
max_size=123,
show_thumbnails=False
),
is_array=False,
max_value=123,
min_value=123,
name="name",
placeholder="placeholder",
read_only=False,
required=False,
step=123,
value="value",
value_mappings=amplifyuibuilder.CfnForm.ValueMappingsProperty(
values=[amplifyuibuilder.CfnForm.ValueMappingProperty(
value=amplifyuibuilder.CfnForm.FormInputValuePropertyProperty(
binding_properties=amplifyuibuilder.CfnForm.FormInputValuePropertyBindingPropertiesProperty(
property="property",
# the properties below are optional
field="field"
),
concat=[form_input_value_property_property_],
value="value"
),
# the properties below are optional
display_value=amplifyuibuilder.CfnForm.FormInputValuePropertyProperty(
binding_properties=amplifyuibuilder.CfnForm.FormInputValuePropertyBindingPropertiesProperty(
property="property",
# the properties below are optional
field="field"
),
concat=[form_input_value_property_property_],
value="value"
)
)],
# the properties below are optional
binding_properties={
"binding_properties_key": amplifyuibuilder.CfnForm.FormInputBindingPropertiesValueProperty(
binding_properties=amplifyuibuilder.CfnForm.FormInputBindingPropertiesValuePropertiesProperty(
model="model"
),
type="type"
)
}
)
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AmplifyUIBuilder;
FormInputValuePropertyProperty formInputValuePropertyProperty_;
var fieldInputConfigProperty = new FieldInputConfigProperty {
Type = "type",
// the properties below are optional
DefaultChecked = false,
DefaultCountryCode = "defaultCountryCode",
DefaultValue = "defaultValue",
DescriptiveText = "descriptiveText",
FileUploaderConfig = new FileUploaderFieldConfigProperty {
AcceptedFileTypes = new [] { "acceptedFileTypes" },
AccessLevel = "accessLevel",
// the properties below are optional
IsResumable = false,
MaxFileCount = 123,
MaxSize = 123,
ShowThumbnails = false
},
IsArray = false,
MaxValue = 123,
MinValue = 123,
Name = "name",
Placeholder = "placeholder",
ReadOnly = false,
Required = false,
Step = 123,
Value = "value",
ValueMappings = new ValueMappingsProperty {
Values = new [] { new ValueMappingProperty {
Value = new FormInputValuePropertyProperty {
BindingProperties = new FormInputValuePropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
Concat = new [] { formInputValuePropertyProperty_ },
Value = "value"
},
// the properties below are optional
DisplayValue = new FormInputValuePropertyProperty {
BindingProperties = new FormInputValuePropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
Concat = new [] { formInputValuePropertyProperty_ },
Value = "value"
}
} },
// the properties below are optional
BindingProperties = new Dictionary<string, object> {
{ "bindingPropertiesKey", new FormInputBindingPropertiesValueProperty {
BindingProperties = new FormInputBindingPropertiesValuePropertiesProperty {
Model = "model"
},
Type = "type"
} }
}
}
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var formInputValuePropertyProperty_ FormInputValuePropertyProperty
fieldInputConfigProperty := &FieldInputConfigProperty{
Type: jsii.String("type"),
// the properties below are optional
DefaultChecked: jsii.Boolean(false),
DefaultCountryCode: jsii.String("defaultCountryCode"),
DefaultValue: jsii.String("defaultValue"),
DescriptiveText: jsii.String("descriptiveText"),
FileUploaderConfig: &FileUploaderFieldConfigProperty{
AcceptedFileTypes: []*string{
jsii.String("acceptedFileTypes"),
},
AccessLevel: jsii.String("accessLevel"),
// the properties below are optional
IsResumable: jsii.Boolean(false),
MaxFileCount: jsii.Number(123),
MaxSize: jsii.Number(123),
ShowThumbnails: jsii.Boolean(false),
},
IsArray: jsii.Boolean(false),
MaxValue: jsii.Number(123),
MinValue: jsii.Number(123),
Name: jsii.String("name"),
Placeholder: jsii.String("placeholder"),
ReadOnly: jsii.Boolean(false),
Required: jsii.Boolean(false),
Step: jsii.Number(123),
Value: jsii.String("value"),
ValueMappings: &ValueMappingsProperty{
Values: []interface{}{
&ValueMappingProperty{
Value: &FormInputValuePropertyProperty{
BindingProperties: &FormInputValuePropertyBindingPropertiesProperty{
Property: jsii.String("property"),
// the properties below are optional
Field: jsii.String("field"),
},
Concat: []interface{}{
formInputValuePropertyProperty_,
},
Value: jsii.String("value"),
},
// the properties below are optional
DisplayValue: &FormInputValuePropertyProperty{
BindingProperties: &FormInputValuePropertyBindingPropertiesProperty{
Property: jsii.String("property"),
// the properties below are optional
Field: jsii.String("field"),
},
Concat: []interface{}{
formInputValuePropertyProperty_,
},
Value: jsii.String("value"),
},
},
},
// the properties below are optional
BindingProperties: map[string]interface{}{
"bindingPropertiesKey": &FormInputBindingPropertiesValueProperty{
"bindingProperties": &FormInputBindingPropertiesValuePropertiesProperty{
"model": jsii.String("model"),
},
"type": jsii.String("type"),
},
},
},
}
Properties
defaultCheckedoptionalboolean | IResolvabledefault_checkedoptionaltyping.Union[bool, IResolvable]defaultCheckedoptionalBooleanDefaultCheckedoptionalboolDefaultCheckedoptionalinterface{}#Specifies whether a field has a default value.
defaultCountryCodeoptionalstringdefault_country_codeoptionalstrdefaultCountryCodeoptionalStringDefaultCountryCodeoptionalstringDefaultCountryCodeoptional*string#The default country code for a phone number.
defaultValueoptionalstringdefault_valueoptionalstrdefaultValueoptionalStringDefaultValueoptionalstringDefaultValueoptional*string#The default value for the field.
descriptiveTextoptionalstringdescriptive_textoptionalstrdescriptiveTextoptionalStringDescriptiveTextoptionalstringDescriptiveTextoptional*string#The text to display to describe the field.
fileUploaderConfigoptionalIResolvable | CfnForm.FileUploaderFieldConfigPropertyfile_uploader_configoptionaltyping.Union[IResolvable, FileUploaderFieldConfigProperty]fileUploaderConfigoptionalIResolvableFileUploaderConfigoptionalIResolvableFileUploaderConfigoptionalinterface{}#The configuration for the file uploader field.
isArrayoptionalboolean | IResolvableis_arrayoptionaltyping.Union[bool, IResolvable]isArrayoptionalBooleanIsArrayoptionalboolIsArrayoptionalinterface{}#Specifies whether to render the field as an array.
This property is ignored if the dataSourceType for the form is a Data Store.
maxValueoptionalnumbermax_valueoptionalint | floatmaxValueoptionalNumberMaxValueoptionaldoubleMaxValueoptional*float64#The maximum value to display for the field.
minValueoptionalnumbermin_valueoptionalint | floatminValueoptionalNumberMinValueoptionaldoubleMinValueoptional*float64#The minimum value to display for the field.
The name of the field.
placeholderoptionalstringplaceholderoptionalstrplaceholderoptionalStringPlaceholderoptionalstringPlaceholderoptional*string#The text to display as a placeholder for the field.
readOnlyoptionalboolean | IResolvableread_onlyoptionaltyping.Union[bool, IResolvable]readOnlyoptionalBooleanReadOnlyoptionalboolReadOnlyoptionalinterface{}#Specifies a read only field.
requiredoptionalboolean | IResolvablerequiredoptionaltyping.Union[bool, IResolvable]requiredoptionalBooleanRequiredoptionalboolRequiredoptionalinterface{}#Specifies a field that requires input.
The stepping increment for a numeric value in a field.
The input type for the field.
The value for the field.
valueMappingsoptionalIResolvable | CfnForm.ValueMappingsPropertyvalue_mappingsoptionaltyping.Union[IResolvable, ValueMappingsProperty]valueMappingsoptionalIResolvableValueMappingsoptionalIResolvableValueMappingsoptionalinterface{}#The information to use to customize the input fields with data at runtime.