aws-cdk-lib.aws_amplifyuibuilder.CfnForm.FileUploaderFieldConfigProperty

interface FileUploaderFieldConfigProperty

LanguageType name
.NETAmazon.CDK.AWS.AmplifyUIBuilder.CfnForm.FileUploaderFieldConfigProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsamplifyuibuilder#CfnForm_FileUploaderFieldConfigProperty
Javasoftware.amazon.awscdk.services.amplifyuibuilder.CfnForm.FileUploaderFieldConfigProperty
Pythonaws_cdk.aws_amplifyuibuilder.CfnForm.FileUploaderFieldConfigProperty
TypeScript aws-cdk-lib » aws_amplifyuibuilder » CfnForm » FileUploaderFieldConfigProperty

Describes the configuration for the file uploader field.

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';
const fileUploaderFieldConfigProperty: amplifyuibuilder.CfnForm.FileUploaderFieldConfigProperty = {
  acceptedFileTypes: ['acceptedFileTypes'],
  accessLevel: 'accessLevel',

  // the properties below are optional
  isResumable: false,
  maxFileCount: 123,
  maxSize: 123,
  showThumbnails: false,
};

Properties

NameTypeDescription
acceptedFileTypesstring[]The file types that are allowed to be uploaded by the file uploader.
accessLevelstringThe access level to assign to the uploaded files in the Amazon S3 bucket where they are stored.
isResumable?boolean | IResolvableAllows the file upload operation to be paused and resumed. The default value is false .
maxFileCount?numberSpecifies the maximum number of files that can be selected to upload.
maxSize?numberThe maximum file size in bytes that the file uploader will accept.
showThumbnails?boolean | IResolvableSpecifies whether to display or hide the image preview after selecting a file for upload.

acceptedFileTypes

Type: string[]

The file types that are allowed to be uploaded by the file uploader.

Provide this information in an array of strings specifying the valid file extensions.


accessLevel

Type: string

The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored.

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?

Type: boolean | IResolvable (optional)

Allows the file upload operation to be paused and resumed. The default value is false .

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?

Type: number (optional)

Specifies the maximum number of files that can be selected to upload.

The default value is an unlimited number of files.


maxSize?

Type: number (optional)

The maximum file size in bytes that the file uploader will accept.

The default value is an unlimited file size.


showThumbnails?

Type: boolean | IResolvable (optional)

Specifies whether to display or hide the image preview after selecting a file for upload.

The default value is true to display the image preview.