Class CfnForm.FileUploaderFieldConfigProperty
Describes the configuration for the file uploader field.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.AmplifyUIBuilder
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class FileUploaderFieldConfigProperty : Object, CfnForm.IFileUploaderFieldConfigProperty
Syntax (vb)
Public Class FileUploaderFieldConfigProperty
Inherits Object
Implements CfnForm.IFileUploaderFieldConfigProperty
Remarks
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 fileUploaderFieldConfigProperty = new FileUploaderFieldConfigProperty {
AcceptedFileTypes = new [] { "acceptedFileTypes" },
AccessLevel = "accessLevel",
// the properties below are optional
IsResumable = false,
MaxFileCount = 123,
MaxSize = 123,
ShowThumbnails = false
};
Synopsis
Constructors
FileUploaderFieldConfigProperty() |
Properties
AcceptedFileTypes | The file types that are allowed to be uploaded by the file uploader. |
AccessLevel | The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. |
IsResumable | Allows the file upload operation to be paused and resumed. The default value is |
MaxFileCount | Specifies the maximum number of files that can be selected to upload. |
MaxSize | The maximum file size in bytes that the file uploader will accept. |
ShowThumbnails | Specifies whether to display or hide the image preview after selecting a file for upload. |
Constructors
FileUploaderFieldConfigProperty()
public FileUploaderFieldConfigProperty()
Properties
AcceptedFileTypes
The file types that are allowed to be uploaded by the file uploader.
public string[] AcceptedFileTypes { get; set; }
Property Value
System.String[]
Remarks
Provide this information in an array of strings specifying the valid file extensions.
AccessLevel
The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored.
public string AccessLevel { get; set; }
Property Value
System.String
Remarks
The valid values for this property are private
, protected
, or public
. For detailed information about the permissions associated with each access level, see File access levels in the Amplify documentation .
IsResumable
Allows the file upload operation to be paused and resumed. The default value is false
.
public object IsResumable { get; set; }
Property Value
System.Object
Remarks
When isResumable
is set to true
, the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn't continuous, because the file uploader uploads a chunk at a time.
MaxFileCount
Specifies the maximum number of files that can be selected to upload.
public Nullable<double> MaxFileCount { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
The default value is an unlimited number of files.
MaxSize
The maximum file size in bytes that the file uploader will accept.
public Nullable<double> MaxSize { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
The default value is an unlimited file size.
ShowThumbnails
Specifies whether to display or hide the image preview after selecting a file for upload.
public object ShowThumbnails { get; set; }
Property Value
System.Object
Remarks
The default value is true
to display the image preview.