You are here

Home » API reference » S3 File System 4.0.x

s3fs.schema.yml in S3 File System 4.0.x

Same filename and directory in other branches
  1. 8.3 config/schema/s3fs.schema.yml
  2. 8.2 config/schema/s3fs.schema.yml
config/schema/s3fs.schema.yml

File

config/schema/s3fs.schema.yml
View source 
  1. s3fs.settings:

  2.   type: config_object

  3.   mapping:

  4.     credentials_file:

  5.       type: string

  6.       label: 'Custom Credentials File Location'

  7.     bucket:

  8.       type: string

  9.       label: 'S3 Bucket Name'

  10.     region:

  11.       type: string

  12.       label: 'S3 Region'

  13.     use_cname:

  14.       type: boolean

  15.       label: 'Enable CNAME'

  16.     domain_root:

  17.       type: string

  18.       label: 'Domain Root'

  19.     use_customhost:

  20.       type: boolean

  21.       label: 'Use a Custom Host'

  22.     hostname:

  23.       type: string

  24.       label: 'Hostname'

  25.     domain:

  26.       type: string

  27.       label: 'CDN Domain Name'

  28.     use_path_style_endpoint:

  29.       type: boolean

  30.       label: 'Use path-style endpoint'

  31.     disable_version_sync:

  32.       type: boolean

  33.       label: 'Disable syncing versions'

  34.     cache_control_header:

  35.       type: string

  36.       label: 'S3 Object Cache-Control Header'

  37.     encryption:

  38.       type: string

  39.       label: 'Server-Side Encryption'

  40.     use_https:

  41.       type: boolean

  42.       label: 'Always serve files from S3 via HTTPS'

  43.     ignore_cache:

  44.       type: boolean

  45.       label: 'Ignore the file metadata cache'

  46.     read_only:

  47.       type: boolean

  48.       label: 'When using the S3 bucket as read only, bypass validation of the ability to upload'

  49.     disable_cert_verify:

  50.       type: boolean

  51.       label: 'Disable verification of SSL/TLS certificate'

  52.     redirect_styles_ttl:

  53.       type: integer

  54.       label: 'The TTL of the redirect cache to the s3 styles'

  55.     root_folder:

  56.       type: string

  57.       label: 'Root Folder'

  58.     public_folder:

  59.       type: string

  60.       label: 'Public Folder'

  61.     private_folder:

  62.       type: string

  63.       label: 'Private Folder'

  64.     presigned_urls:

  65.       type: string

  66.       label: 'Presigned URLs'

  67.     saveas:

  68.       type: string

  69.       label: 'Force Save As'

  70.     torrents:

  71.       type: string

  72.       label: 'Torrents'

  73.     use_cssjs_host:

  74.       type: boolean

  75.       label: 'Use a custom domain for links inside CSS/JS files'

  76.     cssjs_host:

  77.       type: string

  78.       label: 'Custom domain for links inside CSS/JS files'

  79.     use_credentials_cache:

  80.       type: boolean

  81.       label: 'Enable caching of credentials'

  82.     credentials_cache_dir:

  83.       type: string

  84.       label: 'Directory to store cached credentials in'

  85.     keymodule:

  86.       type: mapping

  87.       mapping:

  88.         secret_key_name:

  89.           type: string

  90.           label: 'Key module storage of secret key'

  91.         access_key_name:

  92.           type: string

  93.           label: 'Key module storage of access key'

  94.     disable_shared_config_files:

  95.       type: boolean

  96.       label: 'Disable use of shared config files'