config-library-external-s3-storage
Configures the Amazon S3 storage of library item data.
config-library-external-s3-storage
[-c value | --configuration=value]
[--region=value]
[-b value | --bootstrap-config=value]
[--bucket-name=value]
[--key-prefix=value]
[--access-key=value]
[--secret-key=value]
[--endpoint=value]
[--threads=value]
[--chunk-size=value]
[--threshold=value]
Overview
Use this command for configuring the Amazon S3 storage of library data.Options
Option | Optional or Required | Default Value | Description |
---|---|---|---|
|
Optional | configuration.xml | The path to the server configuration file. |
|
Optional | If not explicitly configured, the default region will be used. | The Amazon AWS region to connect to, for example
eu-central-1 . To clear an already configured value, use
--region="NONE" . If not explicitly configured, an attempt will be made to determine the region from the AWS_REGION system variable and the
~/.aws/config file.
|
|
Optional | none | The path to the bootstrap configuration file. See Bootstrap.xml file for more information about this file. |
|
Optional | none | The Amazon S3 bucket where library data is stored. |
|
Optional | none | The optional key prefix to use for allowing data to be stored in the equivalent of a top level folder. The following restrictions are applied:
|
|
Optional | none | The access key for connecting to Amazon S3. If set to
default , an instance of
DefaultAWSCredentialsProviderChain is created.
DefaultAWSCredentialsProviderChain can take authentication tokens from environment variables, Java system properties, by way of a
config
file, through the Amazon EC2 container, or through instance profile credentials delivered through the Amazon EC2 metadata service. For more information see the documentation for
DefaultAWSCredentialsProviderChain .
|
|
Optional | none | The secret key for connecting to Amazon S3. |
|
Optional | If not explicitly configured, the default region is used. | The Amazon S3 endpoint to connect to. For example,
https://s3.eu-central-1.amazonaws.com .
To clear an already configured value, use
--endpoint="NONE" .
Note: A signing region must also be specified (using the
--region flag) when setting an endpoint.
|
|
Optional | none | The maximum number of threads used for uploading to Amazon S3. |
|
Optional | none | The maximum number of bytes in a chunk when the data is chunked before transfer to Amazon S3. |
|
Optional | none | Above this value, the number of bytes for the transferred data is split into chunks of a configurable size that are then transferred separately to Amazon S3. |
Parent topic: Command-line reference