Package software.amazon.awscdk.services.amplifyuibuilder

Interface CfnForm.FileUploaderFieldConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnForm.FileUploaderFieldConfigProperty.Jsii$Proxy

Enclosing class:

CfnForm

@Stability(Stable)
public static interface CfnForm.FileUploaderFieldConfigProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.amplifyuibuilder.*;
 FileUploaderFieldConfigProperty fileUploaderFieldConfigProperty = FileUploaderFieldConfigProperty.builder()
         .acceptedFileTypes(List.of("acceptedFileTypes"))
         .accessLevel("accessLevel")
         // the properties below are optional
         .isResumable(false)
         .maxFileCount(123)
         .maxSize(123)
         .showThumbnails(false)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnForm.FileUploaderFieldConfigProperty.Builder	A builder for CfnForm.FileUploaderFieldConfigProperty
static final class	CfnForm.FileUploaderFieldConfigProperty.Jsii$Proxy	An implementation for CfnForm.FileUploaderFieldConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnForm.FileUploaderFieldConfigProperty.Builder	builder()
List<String>	getAcceptedFileTypes()	The file types that are allowed to be uploaded by the file uploader.
String	getAccessLevel()	The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored.
default Object	getIsResumable()	Allows the file upload operation to be paused and resumed.
default Number	getMaxFileCount()	Specifies the maximum number of files that can be selected to upload.
default Number	getMaxSize()	The maximum file size in bytes that the file uploader will accept.
default Object	getShowThumbnails()	Specifies whether to display or hide the image preview after selecting a file for upload.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAcceptedFileTypes

@Stability(Stable)
@NotNull
List<String> getAcceptedFileTypes()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html#cfn-amplifyuibuilder-form-fileuploaderfieldconfig-acceptedfiletypes

getAccessLevel

@Stability(Stable)
@NotNull
String getAccessLevel()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html#cfn-amplifyuibuilder-form-fileuploaderfieldconfig-accesslevel

getIsResumable

@Stability(Stable)
@Nullable
default Object getIsResumable()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html#cfn-amplifyuibuilder-form-fileuploaderfieldconfig-isresumable

getMaxFileCount

@Stability(Stable)
@Nullable
default Number getMaxFileCount()

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

The default value is an unlimited number of files.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html#cfn-amplifyuibuilder-form-fileuploaderfieldconfig-maxfilecount

getMaxSize

@Stability(Stable)
@Nullable
default Number getMaxSize()

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

The default value is an unlimited file size.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html#cfn-amplifyuibuilder-form-fileuploaderfieldconfig-maxsize

getShowThumbnails

@Stability(Stable)
@Nullable
default Object getShowThumbnails()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html#cfn-amplifyuibuilder-form-fileuploaderfieldconfig-showthumbnails

builder

@Stability(Stable)
static CfnForm.FileUploaderFieldConfigProperty.Builder builder()

Returns:

a CfnForm.FileUploaderFieldConfigProperty.Builder of CfnForm.FileUploaderFieldConfigProperty