Class: Aws::AmplifyUIBuilder::Types::FileUploaderFieldConfig

Inherits:

Struct

• Object
• Struct
• Aws::AmplifyUIBuilder::Types::FileUploaderFieldConfig

Includes:

Structure

Defined in:

lib/aws-sdk-amplifyuibuilder/types.rb

Overview

Describes the configuration for the file uploader field.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #accepted_file_types ⇒ Array<String>

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

• #access_level ⇒ String

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

• #is_resumable ⇒ Boolean

  Allows the file upload operation to be paused and resumed.

• #max_file_count ⇒ Integer

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

• #max_size ⇒ Integer

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

• #show_thumbnails ⇒ Boolean

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

Instance Attribute Details

#accepted_file_types ⇒ Array<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.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 1819

class FileUploaderFieldConfig < Struct.new(
  :access_level,
  :accepted_file_types,
  :show_thumbnails,
  :is_resumable,
  :max_file_count,
  :max_size)
  SENSITIVE = []
  include Aws::Structure
end

#access_level ⇒ 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*.

[1]: docs.amplify.aws/lib/storage/configureaccess/q/platform/js/

Returns:

• (String)

# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 1819

class FileUploaderFieldConfig < Struct.new(
  :access_level,
  :accepted_file_types,
  :show_thumbnails,
  :is_resumable,
  :max_file_count,
  :max_size)
  SENSITIVE = []
  include Aws::Structure
end

#is_resumable ⇒ Boolean

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.

Returns:

• (Boolean)

# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 1819

class FileUploaderFieldConfig < Struct.new(
  :access_level,
  :accepted_file_types,
  :show_thumbnails,
  :is_resumable,
  :max_file_count,
  :max_size)
  SENSITIVE = []
  include Aws::Structure
end

#max_file_count ⇒ Integer

Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.

Returns:

• (Integer)

# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 1819

class FileUploaderFieldConfig < Struct.new(
  :access_level,
  :accepted_file_types,
  :show_thumbnails,
  :is_resumable,
  :max_file_count,
  :max_size)
  SENSITIVE = []
  include Aws::Structure
end

#max_size ⇒ Integer

The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.

Returns:

• (Integer)

# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 1819

class FileUploaderFieldConfig < Struct.new(
  :access_level,
  :accepted_file_types,
  :show_thumbnails,
  :is_resumable,
  :max_file_count,
  :max_size)
  SENSITIVE = []
  include Aws::Structure
end

#show_thumbnails ⇒ Boolean

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.

Returns:

• (Boolean)

# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 1819

class FileUploaderFieldConfig < Struct.new(
  :access_level,
  :accepted_file_types,
  :show_thumbnails,
  :is_resumable,
  :max_file_count,
  :max_size)
  SENSITIVE = []
  include Aws::Structure
end