Fork me on GitHub

carrotaws:elastic-compute-image-create

Full name:

com.carrotgarden.maven:carrot-maven-aws-plugin:1.2.2:elastic-compute-image-create

Description:

create new ami image from existing AWS ElasticCompute instance

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.
computeServerId String - AWS ElasticCompute amazon security credentials stored in maven settings.xml under server id entry; username="Access Key ID", password="Secret Access Key";
Default value is: com.example.aws.compute.
imageIdResultProperty String - name of project.property which will contain image id after this execution
Default value is: amazonImageId.
imageInstanceId String - AWS ElasticCompute existing instance id to create image from; also can loaded via imageInstanceIdProperty
Default value is: i-12345678.
imageResultProperty String - name of project.property which will contain Image instance after execution of this maven goal, which can be used by groovy script as follows: 
def image = project.properties["amazonImage"]
println "name  = " + image.name
println "state = " + image.state

Default value is: amazonImage.

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.
computeEndpoint String - AWS ElasticCompute optional api end point url which controls amazon region selection; when omitted, will be constructed from computeEndpointFormat and amazonRegion
computeEndpointFormat String - AWS ElasticCompute end point format
Default value is: https://ec2.%s.amazonaws.com.
computeTimeout Long - AWS ElasticCompute operation timeout; seconds
Default value is: 600.
imageDescription String - AWS ElasticCompute ami image description
Default value is: amazon-image-description.
imageInstanceIdProperty String - name of project.property which, if set dynamically, will be used instead of static plug-in property imageInstanceId
imageName String - AWS ElasticCompute AMI image name; must be unique under your aws account; used to tag resources; can be loaded from imageNameProperty
Default value is: amazon-image-name.
imageNameProperty String - name of project.property which, if set dynamically, will be used instead of plug-in property imageName

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

computeEndpoint:

AWS ElasticCompute optional api end point url which controls amazon region selection; when omitted, will be constructed from computeEndpointFormat and amazonRegion
  • Type: java.lang.String
  • Required: No

computeEndpointFormat:

AWS ElasticCompute end point format
  • Type: java.lang.String
  • Required: No
  • Default: https://ec2.%s.amazonaws.com

computeServerId:

AWS ElasticCompute amazon security credentials stored in maven settings.xml under server id entry; username="Access Key ID", password="Secret Access Key";
  • Type: java.lang.String
  • Required: Yes
  • Default: com.example.aws.compute

computeTimeout:

AWS ElasticCompute operation timeout; seconds
  • Type: java.lang.Long
  • Required: No
  • Default: 600

imageDescription:

AWS ElasticCompute ami image description
  • Type: java.lang.String
  • Required: No
  • Default: amazon-image-description

imageIdResultProperty:

name of project.property which will contain image id after this execution
  • Type: java.lang.String
  • Required: Yes
  • Default: amazonImageId

imageInstanceId:

AWS ElasticCompute existing instance id to create image from; also can loaded via imageInstanceIdProperty
  • Type: java.lang.String
  • Required: Yes
  • Default: i-12345678

imageInstanceIdProperty:

name of project.property which, if set dynamically, will be used instead of static plug-in property imageInstanceId
  • Type: java.lang.String
  • Required: No

imageName:

AWS ElasticCompute AMI image name; must be unique under your aws account; used to tag resources; can be loaded from imageNameProperty
  • Type: java.lang.String
  • Required: No
  • Default: amazon-image-name

imageNameProperty:

name of project.property which, if set dynamically, will be used instead of plug-in property imageName
  • Type: java.lang.String
  • Required: No

imageResultProperty:

name of project.property which will contain Image instance after execution of this maven goal, which can be used by groovy script as follows: 
def image = project.properties["amazonImage"]
println "name  = " + image.name
println "state = " + image.state
  • Type: java.lang.String
  • Required: Yes
  • Default: amazonImage