ec2:findinstance

Full name:

org.kuali.maven.plugins:ec2-maven-plugin:1.1.1:findinstance

Description:

Connect to EC2 and find a single instance based on a tag/value pair

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
failIfNotFound boolean - If true, fail the build when no matching instance is found
Default value is: false.
instanceIdProperty String - If supplied, the id of the instance located by the plugin is stored as this project property. If no matching instance is located, the property is set to the value NONE.
Default value is: ec2.instance.id.
secretKey String - The AWS Secret Access Key for an account on EC2
tag String - The name of the tag to search for
Default value is: Name.

Optional Parameters

Name Type Since Description
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>

value String - The value that tag needs to have

Parameter Details

accessKey:

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

failIfNotFound:

If true, fail the build when no matching instance is found
  • Type: boolean
  • Required: Yes
  • Expression: ${ec2.failIfNotFound}
  • Default: false

instanceIdProperty:

If supplied, the id of the instance located by the plugin is stored as this project property. If no matching instance is located, the property is set to the value NONE.
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${ec2.instanceIdProperty}
  • Default: ec2.instance.id

secretKey:

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

tag:

The name of the tag to search for
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${ec2.tag}
  • Default: Name

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

value:

The value that tag needs to have
  • Type: java.lang.String
  • Required: No
  • Expression: ${ec2.value}