Class CfnForm

The AWS::AmplifyUIBuilder::Form resource specifies all of the information that is required to create a form.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnForm

Implements

IInspectable

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.AmplifyUIBuilder

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnForm : CfnResource, IInspectable, ITaggable

Syntax (vb)

Public Class CfnForm Inherits CfnResource Implements IInspectable, ITaggable

Remarks

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

CloudformationResource: AWS::AmplifyUIBuilder::Form

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;

             FormInputValuePropertyProperty formInputValuePropertyProperty_;

             var cfnForm = new CfnForm(this, "MyCfnForm", new CfnFormProps {
                 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"
                         }
                     }
                 },
                 DataType = new FormDataTypeConfigProperty {
                     DataSourceType = "dataSourceType",
                     DataTypeName = "dataTypeName"
                 },
                 EnvironmentName = "environmentName",
                 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 {
                                         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"
                                     } }
                                 }
                             }
                         },
                         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",
                 LabelDecorator = "labelDecorator",
                 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"
                     }
                 },
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             });

Synopsis

Constructors

CfnForm(Construct, string, ICfnFormProps?)

The AWS::AmplifyUIBuilder::Form resource specifies all of the information that is required to create a form.

Properties

AppId	The unique ID of the Amplify app associated with the form.
AttrId	The ID for the form.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The AWS::AmplifyUIBuilder::Form resource specifies all of the information that is required to create a 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	Specifies an icon or decoration to display on the form.
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	Tag Manager which manages the tags for this resource.
TagsRaw	One or more key-value pairs to use when tagging the form data.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	The AWS::AmplifyUIBuilder::Form resource specifies all of the information that is required to create a form.

Constructors

CfnForm(Construct, string, ICfnFormProps?)

The AWS::AmplifyUIBuilder::Form resource specifies all of the information that is required to create a form.

public CfnForm(Construct scope, string id, ICfnFormProps? props = null)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnFormProps: Resource properties.

Remarks

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

CloudformationResource: AWS::AmplifyUIBuilder::Form

ExampleMetadata: fixture=_generated

Properties

AppId

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

public virtual string? AppId { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::AmplifyUIBuilder::Form

ExampleMetadata: fixture=_generated

AttrId

The ID for the form.

public virtual string AttrId { get; }

Property Value

string

Remarks

CloudformationAttribute: Id

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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

CloudformationResource: AWS::AmplifyUIBuilder::Form

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::AmplifyUIBuilder::Form resource specifies all of the information that is required to create a form.

protected override IDictionary<string, object> CfnProperties { get; }

CloudformationResource: AWS::AmplifyUIBuilder::Form

ExampleMetadata: fixture=_generated

Cta

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

public virtual object? Cta { get; set; }

Property Value

object

Remarks

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

CloudformationResource: AWS::AmplifyUIBuilder::Form

ExampleMetadata: fixture=_generated

DataType

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

public virtual object? DataType { get; set; }

Property Value

object

Remarks

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

CloudformationResource: AWS::AmplifyUIBuilder::Form

ExampleMetadata: fixture=_generated

EnvironmentName

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

public virtual string? EnvironmentName { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::AmplifyUIBuilder::Form

ExampleMetadata: fixture=_generated

Fields

The configuration information for the form's fields.

public virtual object? Fields { get; set; }

Property Value

object

Remarks

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

CloudformationResource: AWS::AmplifyUIBuilder::Form

ExampleMetadata: fixture=_generated

FormActionType

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

public virtual string? FormActionType { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::AmplifyUIBuilder::Form

ExampleMetadata: fixture=_generated

LabelDecorator

Specifies an icon or decoration to display on the form.

public virtual string? LabelDecorator { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::AmplifyUIBuilder::Form

ExampleMetadata: fixture=_generated

Name

The name of the form.

public virtual string? Name { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::AmplifyUIBuilder::Form

ExampleMetadata: fixture=_generated

SchemaVersion

The schema version of the form.

public virtual string? SchemaVersion { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::AmplifyUIBuilder::Form

ExampleMetadata: fixture=_generated

SectionalElements

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

public virtual object? SectionalElements { get; set; }

Property Value

object

Remarks

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

CloudformationResource: AWS::AmplifyUIBuilder::Form

ExampleMetadata: fixture=_generated

Style

The configuration for the form's style.

public virtual object? Style { get; set; }

Property Value

object

Remarks

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

CloudformationResource: AWS::AmplifyUIBuilder::Form

ExampleMetadata: fixture=_generated

TagsRaw

One or more key-value pairs to use when tagging the form data.

public virtual IDictionary<string, string>? TagsRaw { get; set; }

Property Value

IDictionary<string, string>

Remarks

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

CloudformationResource: AWS::AmplifyUIBuilder::Form

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

Remarks

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

CloudformationResource: AWS::AmplifyUIBuilder::Form

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::AmplifyUIBuilder::Form resource specifies all of the information that is required to create a form.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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

CloudformationResource: AWS::AmplifyUIBuilder::Form

ExampleMetadata: fixture=_generated

Implements

IInspectable

ITaggable