Fork me on GitHub

carrotaws:elastic-compute-image-delete

Full name:

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

Description:

delete existing ami image with all ebs snapshots

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.
imageId String - AWS ElasticCompute existing image id to delete; also can loaded via imageIdProperty
Default value is: ami-12345678.

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.
imageIdProperty String - name of project.property which, if set dynamically, will be used instead of static plug-in property imageId

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

imageId:

AWS ElasticCompute existing image id to delete; also can loaded via imageIdProperty
  • Type: java.lang.String
  • Required: Yes
  • Default: ami-12345678

imageIdProperty:

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