ec2:terminateinstance

Full name:

org.kuali.maven.plugins:ec2-maven-plugin:1.1.0-SNAPSHOT:terminateinstance

Description:

Connect to EC2 and terminate the indicated instance.

Attributes:

  • Requires a Maven project to be executed.

Required Parameters

Name Type Since Description
accessKey String - The AWS Access Key Id for an account on EC2
instanceId String - The id of the instance to terminate. Set this to NONE to skip attempting to terminate an instance
secretKey String - The AWS Secret Access Key for an account on EC2

Optional Parameters

Name Type Since Description
state String - The state the instance needs to be in before the plugin considers it to be terminated.
Default value is: terminated.
tags List - List of tags. Tags are name/value pairs and can be supplied in the plugin configuration like this:
  <tags>
    <tag>
      <key>Name</key>
      <value>production</value>
    </tag>
    <tag>
      <key>Category</key>
      <value>networking</value>
    </tag>
  </tags>

wait boolean - If true, the build will wait until EC2 reports that the instance has reached the state of "terminated"
Default value is: false.
waitTimeout int - The number of seconds to wait for the instance to terminate before timing out and failing the build
Default value is: 300.

Parameter Details

accessKey:

The AWS Access Key Id for an account on EC2
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${ec2.accessKey}

instanceId:

The id of the instance to terminate. Set this to NONE to skip attempting to terminate an instance
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${ec2.instanceId}

secretKey:

The AWS Secret Access Key for an account on EC2
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${ec2.secretKey}

state:

The state the instance needs to be in before the plugin considers it to be terminated.
  • Type: java.lang.String
  • Required: No
  • Expression: ${ec2.state}
  • Default: terminated

tags:

List of tags. Tags are name/value pairs and can be supplied in the plugin configuration like this:
  <tags>
    <tag>
      <key>Name</key>
      <value>production</value>
    </tag>
    <tag>
      <key>Category</key>
      <value>networking</value>
    </tag>
  </tags>
  • Type: java.util.List
  • Required: No

wait:

If true, the build will wait until EC2 reports that the instance has reached the state of "terminated"
  • Type: boolean
  • Required: No
  • Expression: ${ec2.wait}
  • Default: false

waitTimeout:

The number of seconds to wait for the instance to terminate before timing out and failing the build
  • Type: int
  • Required: No
  • Expression: ${ec2.waitTimeout}
  • Default: 300