Interface ICfnFormProps

Properties for defining a CfnForm.

Namespace: Amazon.CDK.AWS.AmplifyUIBuilder

Assembly: Amazon.CDK.AWS.AmplifyUIBuilder.dll

Syntax (csharp)

public interface ICfnFormProps

Syntax (vb)

Public Interface ICfnFormProps

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AmplifyUIBuilder;

var cfnFormProps = new CfnFormProps {
    DataType = new FormDataTypeConfigProperty {
        DataSourceType = "dataSourceType",
        DataTypeName = "dataTypeName"
    },
    Fields = new Dictionary<string, object> {
        { "fieldsKey", new FieldConfigProperty {
            Excluded = false,
            InputType = 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 {
                            Value = "value"
                        },

                        // the properties below are optional
                        DisplayValue = new FormInputValuePropertyProperty {
                            Value = "value"
                        }
                    } }
                }
            },
            Label = "label",
            Position = new FieldPositionProperty {
                Below = "below",
                Fixed = "fixed",
                RightOf = "rightOf"
            },
            Validations = new [] { new FieldValidationConfigurationProperty {
                Type = "type",

                // the properties below are optional
                NumValues = new [] { 123 },
                StrValues = new [] { "strValues" },
                ValidationMessage = "validationMessage"
            } }
        } }
    },
    FormActionType = "formActionType",
    Name = "name",
    SchemaVersion = "schemaVersion",
    SectionalElements = new Dictionary<string, object> {
        { "sectionalElementsKey", new SectionalElementProperty {
            Type = "type",

            // the properties below are optional
            Excluded = false,
            Level = 123,
            Orientation = "orientation",
            Position = new FieldPositionProperty {
                Below = "below",
                Fixed = "fixed",
                RightOf = "rightOf"
            },
            Text = "text"
        } }
    },
    Style = new FormStyleProperty {
        HorizontalGap = new FormStyleConfigProperty {
            TokenReference = "tokenReference",
            Value = "value"
        },
        OuterPadding = new FormStyleConfigProperty {
            TokenReference = "tokenReference",
            Value = "value"
        },
        VerticalGap = new FormStyleConfigProperty {
            TokenReference = "tokenReference",
            Value = "value"
        }
    },

    // the properties below are optional
    AppId = "appId",
    Cta = new FormCTAProperty {
        Cancel = new FormButtonProperty {
            Children = "children",
            Excluded = false,
            Position = new FieldPositionProperty {
                Below = "below",
                Fixed = "fixed",
                RightOf = "rightOf"
            }
        },
        Clear = new FormButtonProperty {
            Children = "children",
            Excluded = false,
            Position = new FieldPositionProperty {
                Below = "below",
                Fixed = "fixed",
                RightOf = "rightOf"
            }
        },
        Position = "position",
        Submit = new FormButtonProperty {
            Children = "children",
            Excluded = false,
            Position = new FieldPositionProperty {
                Below = "below",
                Fixed = "fixed",
                RightOf = "rightOf"
            }
        }
    },
    EnvironmentName = "environmentName",
    LabelDecorator = "labelDecorator",
    Tags = new Dictionary<string, string> {
        { "tagsKey", "tags" }
    }
};

Synopsis

Properties

AppId	The unique ID of the Amplify app associated with the form.
Cta	The `FormCTA` object that stores the call to action configuration for the form.
DataType	The type of data source to use to create the form.
EnvironmentName	The name of the backend environment that is a part of the Amplify app.
Fields	The configuration information for the form's fields.
FormActionType	Specifies whether to perform a create or update action on the form.
LabelDecorator	`AWS::AmplifyUIBuilder::Form.LabelDecorator`.
Name	The name of the form.
SchemaVersion	The schema version of the form.
SectionalElements	The configuration information for the visual helper elements for the form.
Style	The configuration for the form's style.
Tags	One or more key-value pairs to use when tagging the form data.

Properties

AppId

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

virtual string AppId { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-appid

Cta

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

virtual object Cta { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-cta

DataType

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

object DataType { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-datatype

EnvironmentName

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

virtual string EnvironmentName { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-environmentname

Fields

The configuration information for the form's fields.

object Fields { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-fields

FormActionType

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

string FormActionType { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-formactiontype

LabelDecorator

AWS::AmplifyUIBuilder::Form.LabelDecorator.

virtual string LabelDecorator { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-labeldecorator

Name

The name of the form.

string Name { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-name

SchemaVersion

The schema version of the form.

string SchemaVersion { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-schemaversion

SectionalElements

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

object SectionalElements { get; }

Property Value

System.Object

Remarks

These elements are not associated with any data.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-sectionalelements

Style

The configuration for the form's style.

object Style { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-style