s3-upload-maven-plugin

maven plugin to upload files to amazon s3

License

License

Categories

Categories

Maven Build Tools
GroupId

GroupId

io.dangernoodle
ArtifactId

ArtifactId

s3-upload-maven-plugin
Last Version

Last Version

2.0.0
Release Date

Release Date

Type

Type

maven-plugin
Description

Description

s3-upload-maven-plugin
maven plugin to upload files to amazon s3
Project URL

Project URL

https://github.com/dangernoodle-io/s3-upload-maven-plugin
Project Organization

Project Organization

dangernoodle.io
Source Code Management

Source Code Management

https://github.com/dangernoodle-io/s3-upload-maven-plugin

Download s3-upload-maven-plugin

How to add to project

<plugin>
    <groupId>io.dangernoodle</groupId>
    <artifactId>s3-upload-maven-plugin</artifactId>
    <version>2.0.0</version>
</plugin>

Dependencies

compile (4)

Group / Artifact Type Version
org.apache.maven : maven-plugin-api jar 3.6.2
org.apache.maven.plugin-tools : maven-plugin-annotations Optional jar 3.6.0
com.amazonaws : aws-java-sdk-s3 jar 1.10.69
com.amazonaws : aws-java-sdk-sts jar 1.10.69

runtime (1)

Group / Artifact Type Version
org.glassfish.jaxb : jaxb-runtime jar 2.3.1

Project Modules

There are no modules declared in this project.

s3-upload-maven-plugin

Uploads a file or (recursively) the contents of a directory to S3.

Configuration parameters

Parameter Description Required Default
bucketName The name of the bucket yes
source The source file or folder (was sourceFile before 1.2) yes
destination The destination file or destination folder (was destinationFile before 1.2). yes
recursive If this is a directory copy, recursively copy all contents (since 1.2) no false
accessKey S3 access key no if unspecified, uses the Default Provider, falling back to env variables
secretKey S3 secret key no if unspecified, uses the Default Provider, falling back to env variables
doNotUpload Dry run no false
endpoint Use a different s3 endpoint no s3.amazonaws.com

Example: Upload a file

<build>
  <plugins>
    <plugin>
      <groupId>io.dangernoodle</groupId>
      <artifactId>s3-upload-maven-plugin</artifactId>
      <version>${s3-upload-maven-plugin.version}</version>
      <configuration>
        <bucketName>my-s3-bucket</bucketName>
        <source>dir/filename.txt</source>
        <destination>remote-dir/remote-filename.txt</destination>
      </configuration>
    </plugin>
  </plugins>
</build>

Example: Recursively upload a folder

<build>
  <plugins>
    <plugin>
      <groupId>io.dangernoodle</groupId>
      <artifactId>s3-upload-maven-plugin</artifactId>
      <version>${s3-upload-maven-plugin.version}</version>
      <configuration>
        <bucketName>my-s3-bucket</bucketName>
        <source>dir</source>
        <destination>remote-dir</destination>
        <recursive>true</recursive>
      </configuration>
    </plugin>
  </plugins>
</build>
io.dangernoodle

Versions

Version
2.0.0