Fork me on GitHub

carrotaws:secure-shell-retrieve

Full name:

com.carrotgarden.maven:carrot-maven-aws-plugin:1.2.2:secure-shell-retrieve

Description:

retrieve directory content via sftp from remote to local system

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • Binds by default to the lifecycle phase: prepare-package.

Required Parameters

Name Type Since Description
amazonRegion String - AWS region name, such as us-east-1, which controls amazon region selection; alternatively, see amazonRegionProperty
Default value is: us-east-1.
sshHost String - ssh host name
Default value is: builder.example.com.
sshKeyFile String - ssh key file
Default value is: ${user.home}/.amazon/ssh-key.pem.
sshSource String - ssh sftp source directory on remote file system
Default value is: /tmp/retrieve.
sshTarget String - ssh sftp target directory on local file system
Default value is: ./target/retrieve.
sshUser String - ssh user name
Default value is: ubuntu.

Optional Parameters

Name Type Since Description
amazonRegionProperty String - name of project.property which, if set dynamically, will be used instead of plugin property amazonRegion
amazonTagName String - default amazon tag for resource names
Default value is: Name.
sshConnectRetries int - How many times to attempt to retry ssh connection before giving up
Default value is: 5.
sshConnectTimeout int - How long (in seconds) to wait if a ssh connection fails before retrying
Default value is: 10.
sshHostProperty String - ssh host name property; if present, will use dynamic project.property instead of static plug-in property sshHost
sshKeyFileProperty String - ssh key file property; if present, will use dynamic project.property instead of static plug-in property sshKeyFile
sshPort String - ssh host port
Default value is: 22.
sshPortProperty String - ssh host port property; if present, will use dynamic project.property instead of static plug-in property sshPort
sshStatusSuccess Set - ssh run expected exit success status collection; contains 0 by default
sshUserProperty String - ssh user name property; if present, will use dynamic project.property instead of static plug-in property sshUser

Parameter Details

amazonRegion:

AWS region name, such as us-east-1, which controls amazon region selection; alternatively, see amazonRegionProperty
  • Type: java.lang.String
  • Required: Yes
  • Default: us-east-1

amazonRegionProperty:

name of project.property which, if set dynamically, will be used instead of plugin property amazonRegion
  • Type: java.lang.String
  • Required: No

amazonTagName:

default amazon tag for resource names
  • Type: java.lang.String
  • Required: No
  • Default: Name

sshConnectRetries:

How many times to attempt to retry ssh connection before giving up
  • Type: int
  • Required: No
  • Default: 5

sshConnectTimeout:

How long (in seconds) to wait if a ssh connection fails before retrying
  • Type: int
  • Required: No
  • Default: 10

sshHost:

ssh host name
  • Type: java.lang.String
  • Required: Yes
  • Default: builder.example.com

sshHostProperty:

ssh host name property; if present, will use dynamic project.property instead of static plug-in property sshHost
  • Type: java.lang.String
  • Required: No

sshKeyFile:

ssh key file
  • Type: java.lang.String
  • Required: Yes
  • Default: ${user.home}/.amazon/ssh-key.pem

sshKeyFileProperty:

ssh key file property; if present, will use dynamic project.property instead of static plug-in property sshKeyFile
  • Type: java.lang.String
  • Required: No

sshPort:

ssh host port
  • Type: java.lang.String
  • Required: No
  • Default: 22

sshPortProperty:

ssh host port property; if present, will use dynamic project.property instead of static plug-in property sshPort
  • Type: java.lang.String
  • Required: No

sshSource:

ssh sftp source directory on remote file system
  • Type: java.lang.String
  • Required: Yes
  • Default: /tmp/retrieve

sshStatusSuccess:

ssh run expected exit success status collection; contains 0 by default
  • Type: java.util.Set
  • Required: No

sshTarget:

ssh sftp target directory on local file system
  • Type: java.lang.String
  • Required: Yes
  • Default: ./target/retrieve

sshUser:

ssh user name
  • Type: java.lang.String
  • Required: Yes
  • Default: ubuntu

sshUserProperty:

ssh user name property; if present, will use dynamic project.property instead of static plug-in property sshUser
  • Type: java.lang.String
  • Required: No