/s3-download-maven-plugin

Allows you to download files from S3 directly from maven.

Primary LanguageJava

s3-download-maven-plugin

Downloads a file or (recursively) the contents of a directory from S3.

Configuration parameters

Parameter Description Required Default
bucketName The name of the bucket yes
source The source amazon s3 file key. Empty to download the whole bucket. no
relative If source a directory, use relative from directory no false
exclude extension of file to exclude no
destination The destination file or destination folder. Directories MUST end with / yes
accessKey S3 access key yes if unspecified, uses the Default Provider, falling back to env variables
secretKey S3 secret key yes if unspecified, uses the Default Provider, falling back to env variables
endpoint Use a different s3 endpoint no s3.amazonaws.com

s3-download.relative

Example: Download a bucket

<build>
  ...

  <plugins>
    ...

    <plugin>
      <groupId>com.upplication.maven.plugins</groupId>
      <artifactId>s3-download-maven-plugin</artifactId>
      <version>1.0.2-SNAPSHOT</version>
      <executions>
        <execution>
            <phase>your phase</phase>
            <goals>
                <goal>s3-download</goal>
            </goals>
            <configuration>
                <bucketName>my-s3-bucket</bucketName>
                <!-- if you provide no source the whole bucket will be downloaded -->
                <destination>/my/local/dir/</destination>
                <accessKey>access key</accessKey>
                <secretKey>secret key</secretKey>
            </configuration>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>