Fork me on GitHub

carrotaws:groovy-execute-script

Full name:

com.carrotgarden.maven:carrot-maven-aws-plugin:1.2.2:groovy-execute-script

Description:

groovy script executor; has access to MavenProject;

for example:

def value = project.properties['key'] // read from project
project.properties['key'] = value + 1 // save into project

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.
groovyFile File - groovy external script file; if present, executed before groovyText
Default value is: ./target/script.groovy.

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.
groovyIsCommandProperties boolean - should load all user properties (a.k.a maven command line properties) into project.properties during script execution?
Default value is: true.
groovyIsProjectProperties boolean - should load all project properties from current pom.xml model state into project.properties during script execution?
Default value is: true.
groovyIsSystemProperties boolean - should load all system properties from System.getenv() System.getProperties() into project.properties during script execution?
Default value is: true.
groovyText String - groovy script text in pom.xml; if present, executed after groovyFile

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

groovyFile:

groovy external script file; if present, executed before groovyText
  • Type: java.io.File
  • Required: Yes
  • Default: ./target/script.groovy

groovyIsCommandProperties:

should load all user properties (a.k.a maven command line properties) into project.properties during script execution?
  • Type: boolean
  • Required: No
  • Default: true

groovyIsProjectProperties:

should load all project properties from current pom.xml model state into project.properties during script execution?
  • Type: boolean
  • Required: No
  • Default: true

groovyIsSystemProperties:

should load all system properties from System.getenv() System.getProperties() into project.properties during script execution?
  • Type: boolean
  • Required: No
  • Default: true

groovyText:

groovy script text in pom.xml; if present, executed after groovyFile
  • Type: java.lang.String
  • Required: No