interface CfnFormProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.AmplifyUIBuilder.CfnFormProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsamplifyuibuilder#CfnFormProps |
![]() | software.amazon.awscdk.services.amplifyuibuilder.CfnFormProps |
![]() | aws_cdk.aws_amplifyuibuilder.CfnFormProps |
![]() | aws-cdk-lib » aws_amplifyuibuilder » CfnFormProps |
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 { aws_amplifyuibuilder as amplifyuibuilder } from 'aws-cdk-lib';
declare const formInputValuePropertyProperty_: amplifyuibuilder.CfnForm.FormInputValuePropertyProperty;
const cfnFormProps: amplifyuibuilder.CfnFormProps = {
appId: 'appId',
cta: {
cancel: {
children: 'children',
excluded: false,
position: {
below: 'below',
fixed: 'fixed',
rightOf: 'rightOf',
},
},
clear: {
children: 'children',
excluded: false,
position: {
below: 'below',
fixed: 'fixed',
rightOf: 'rightOf',
},
},
position: 'position',
submit: {
children: 'children',
excluded: false,
position: {
below: 'below',
fixed: 'fixed',
rightOf: 'rightOf',
},
},
},
dataType: {
dataSourceType: 'dataSourceType',
dataTypeName: 'dataTypeName',
},
environmentName: 'environmentName',
fields: {
fieldsKey: {
excluded: false,
inputType: {
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',
},
},
},
},
label: 'label',
position: {
below: 'below',
fixed: 'fixed',
rightOf: 'rightOf',
},
validations: [{
type: 'type',
// the properties below are optional
numValues: [123],
strValues: ['strValues'],
validationMessage: 'validationMessage',
}],
},
},
formActionType: 'formActionType',
labelDecorator: 'labelDecorator',
name: 'name',
schemaVersion: 'schemaVersion',
sectionalElements: {
sectionalElementsKey: {
type: 'type',
// the properties below are optional
excluded: false,
level: 123,
orientation: 'orientation',
position: {
below: 'below',
fixed: 'fixed',
rightOf: 'rightOf',
},
text: 'text',
},
},
style: {
horizontalGap: {
tokenReference: 'tokenReference',
value: 'value',
},
outerPadding: {
tokenReference: 'tokenReference',
value: 'value',
},
verticalGap: {
tokenReference: 'tokenReference',
value: 'value',
},
},
tags: {
tagsKey: 'tags',
},
};
Properties
Name | Type | Description |
---|---|---|
app | string | The unique ID of the Amplify app associated with the form. |
cta? | IResolvable | Form | The FormCTA object that stores the call to action configuration for the form. |
data | IResolvable | Form | The type of data source to use to create the form. |
environment | string | The name of the backend environment that is a part of the Amplify app. |
fields? | IResolvable | { [string]: IResolvable | Field } | The configuration information for the form's fields. |
form | string | Specifies whether to perform a create or update action on the form. |
label | string | Specifies an icon or decoration to display on the form. |
name? | string | The name of the form. |
schema | string | The schema version of the form. |
sectional | IResolvable | { [string]: IResolvable | Sectional } | The configuration information for the visual helper elements for the form. |
style? | IResolvable | Form | The configuration for the form's style. |
tags? | { [string]: string } | One or more key-value pairs to use when tagging the form data. |
appId?
Type:
string
(optional)
The unique ID of the Amplify app associated with the form.
cta?
Type:
IResolvable
|
Form
(optional)
The FormCTA
object that stores the call to action configuration for the form.
dataType?
Type:
IResolvable
|
Form
(optional)
The type of data source to use to create the form.
environmentName?
Type:
string
(optional)
The name of the backend environment that is a part of the Amplify app.
fields?
Type:
IResolvable
| { [string]:
IResolvable
|
Field
}
(optional)
The configuration information for the form's fields.
formActionType?
Type:
string
(optional)
Specifies whether to perform a create or update action on the form.
labelDecorator?
Type:
string
(optional)
Specifies an icon or decoration to display on the form.
name?
Type:
string
(optional)
The name of the form.
schemaVersion?
Type:
string
(optional)
The schema version of the form.
sectionalElements?
Type:
IResolvable
| { [string]:
IResolvable
|
Sectional
}
(optional)
The configuration information for the visual helper elements for the form.
These elements are not associated with any data.
style?
Type:
IResolvable
|
Form
(optional)
The configuration for the form's style.
tags?
Type:
{ [string]: string }
(optional)
One or more key-value pairs to use when tagging the form data.