Amazon EC2 Parameters

The following input and output parameters are supported in the EC2 Cloud. Parameters are accessed via $<vmname.parameterName>

Supported input parameters

 
 parameterName  Description  Type
 availabilityZone  Specifies the placement constraints (Availability Zones) for launching the instances.  String
 groupName  Specifies the name of a placement group. Cannot be used for spot instances  String
 availabilityZoneGroup  If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.  String
 launchGroup  The instance launch group. Launch groups are Spot Instances that launch together and terminate together  String
 instanceInitiatedShutdownBehavior  If an instance shutdown is initiated, this determines whether the instance stops or terminates. Valid Values: stop | terminate  String
 instanceType  specifies virtual machine size. Valid Values: t1.micro | m1.small | m1.large | m1.xlarge | m2.xlarge | m2.2xlarge | m2.4xlarge | c1.medium | c1.xlarge  String
 imageId  Unique ID of a machine image, returned by a call to RegisterImage  String
 keyName  Name of the SSH key to be used for communication with the VM  String
 minCount  Minimum number of instances to launch. If the value is more than Amazon EC2 can launch, no instances are launched at all.  Long
 maxCount  Maximum number of instances to launch. If the value is more than Amazon EC2 can launch, the largest possible number above minCount will be launched instead.  Long
 monitoring  Specifies whether monitoring is enabled for the instance.  Boolean
 securityGroups  Name of the security group which controls the open TCP/IP ports for the VM.  String
 spotPrice  Maximum hourly price for instance. If not specified then an on-demand instance is used  Double
 userData  Base64-encoded MIME user data made available to the instance(s). May be used to pass startup commands.  String

 

Supported Output Parameters

 
 paramaterName    Description  Type
 amiLaunchIndex  The AMI launch index, which can be used to find this instance within the launch group.  String
 architecture  The architecture of the image.  String
 dnsName  The public DNS name assigned to the instance. This DNS name is contactable from outside the Amazon EC2 network. This element remains empty until the instance enters a running state.  String
 imageId  Specifies the name of a placement group.  String
 instanceInitiatedShutdownBehavior  If an instance shutdown is initiated, this determines whether the instance stops or terminates. Valid Values: stop | terminate  String
 instanceType  specifies virtual machine size. Valid Values: t1.micro | m1.small | m1.large | m1.xlarge | m2.xlarge | m2.2xlarge | m2.4xlarge | c1.medium | c1.xlarge  Long
 imageId  Image ID of the AMI used to launch the instance.  String
 instanceId  Unique ID of the instance launched.  String
 instanceLifecycle  Specifies whether this is a Spot Instance.  String
 instanceState  State of the instance. code: A 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. Valid Values: 0 (pending) | 16 (running) | 32 (shutting-down) | 48 (terminated) | 64 (stopping) | 80 (stopped). name: Valid Values: pending | running | shutting-down | terminated | stopping | stopped  String
 instanceType  specifies virtual machine size. Valid Values: t1.micro | m1.small | m1.large | m1.xlarge | m2.xlarge | m2.2xlarge | m2.4xlarge | c1.medium | c1.xlarge  String
 publicIpAddress  Specifies the public IP address of the instance.  String
 kernelId  Kernel associated with this instance.  String
 keyName  Name of the SSH key to be used for communication with the VM  String
 launchTime  The time the instance launched  String
 monitoring  Specifies whether monitoring is enabled for the instance. state: true | false  String
 placement  The location where the instance launched. availabilityZone: Availability Zone of the instance  String
 platform  The Platform of the instance (e.g., Windows).  String
 privateDnsName  The private DNS name assigned to the instance. This DNS name can only be used inside the Amazon EC2 network. This element remains empty until the instance enters a running state.  String
 privateIpAddress  Specifies the private IP address that is assigned to the instance.  String
 productCodes  Product codes attached to this instance.  String
 ramdiskId  RAM disk associated with this instance.  String
 reason  Reason for the most recent state transition. This might be an empty string.  String
 rootDeviceName  The root device name (e.g., /dev/sda1).  String
 rootDeviceType  The root device type used by the AMI. The AMI can use an Amazon EBS or instance store root device.  String
 spotInstanceRequestId  The ID of the Spot Instance request.  String
 stateReason  The reason for the state change. code: Reason code for the state change message: Message for the state change  String
 subnetId  Specifies the Amazon VPC subnet ID in which the instance is running.  String
 virtualizationType  Specifies the instance's virtualization type (paravirtual or hvm).  String
 vpcId  Specifies the Amazon VPC in which the instance is running.  String
Comments