ec2:createsnapshot

Full name:

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

Description:

Create a snapshot of a volume. If successful, the project property ec2.snapshot.id will contain the id of the snapshot that was created.

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
secretKey String - The AWS Secret Access Key for an account on EC2
volumeId String - The volume to take a snapshot of

Optional Parameters

Name Type Since Description
description String - The description of the snapshot (if any)
sleep int - The number of seconds to sleep in between status checks on the snapshot
Default value is: 30.
state String - The state the plugin will wait for the snapshot to be in before continuing
Default value is: completed.
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 snapshot has reached the state of "completed"
Default value is: true.
waitTimeout int - The number of seconds to wait for the instance to terminate before timing out and failing the build
Default value is: 7200.

Parameter Details

accessKey:

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

description:

The description of the snapshot (if any)
  • Type: java.lang.String
  • Required: No
  • Expression: ${ec2.description}

secretKey:

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

sleep:

The number of seconds to sleep in between status checks on the snapshot
  • Type: int
  • Required: No
  • Expression: ${ec2.sleep}
  • Default: 30

state:

The state the plugin will wait for the snapshot to be in before continuing
  • Type: java.lang.String
  • Required: No
  • Expression: ${ec2.state}
  • Default: completed

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

volumeId:

The volume to take a snapshot of
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${ec2.volumeId}

wait:

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

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: 7200