JBoss.org Community Documentation

8.3.4.2. Configuration

At a minimum, you must configure your Amazon S3 access key and secret access key. The following configuration keys are listed in general order of utility.

  • cache.s3.accessKeyId - Amazon S3 Access Key, available from your account profile.

  • cache.s3.secretAccessKey - Amazon S3 Secret Access Key, available from your account profile. As this is a password, be careful not to distribute it or include this secret key in built software.

  • cache.s3.secure - The default isfalse: Traffic is sent unencrypted over the public Internet. Set to true to use HTTPS. Note that unencrypted uploads and downloads use less CPU.

  • cache.s3.bucket - Name of the bucket to store data. For different caches using the same access key, use a different bucket name. Read the S3 documentation on the definition of a bucket. The default value is jboss-cache.

  • cache.s3.callingFormat - One of PATH, SUBDOMAIN, or VANITY. Read the S3 documentation on the use of calling domains. The default value is SUBDOMAIN.

  • cache.s3.optimize - The default is false. If true, put(Map) operations replace the data stored at an Fqn rather than attempt to fetch and merge. (This option is fairly experimental at the moment.)

  • cache.s3.parentCache - The default is true. Set this value to false if you are using multiple caches sharing the same S3 bucket, that remove parent nodes of nodes being created in other caches. (This is not a common use case.)

    • JBoss Cache stores nodes in a tree format and automatically creates intermediate parent nodes as necessary. The S3 cache loader must also create these parent nodes as well to allow for operations such as getChildrenNames to work properly. Checking if all parent nodes exists for every put operation is fairly expensive, so by default the cache loader caches the existence of these parent nodes.

  • cache.s3.location - This choses a primary storage location for your data to reduce loading and retrevial latency. Set to EU to store data in Europe. The default is null, to store data in the United States.