|
Amazon EC2 - Launch instance |
Declaration
<AMAWSEC2 PROVIDER="session_based" SESSION="text" ACCESSKEY="text" SECRETKEY="text (encrypted)" USERAGENT="text" MAXERRORRETRY="number" SERVICEURL="text" PROXYHOST="text" PROXYPORT="number" PROXYUSER="text" PROXYPWD="text (encrypted)" SIGNMETHOD="text" SIGNVERSION="number" IMAGEID="text (options)" INSTANCETYPE="text (options)" SECURITYGROUP="text" KEYPAIR="text" ZONE="text (options)" TOTALINSTANCES="number" KERNALID="text" RAMDISKID="text" USERDATA="text" SUBNETID="text" MONITORING="YES/NO" RESULTDATASET="text" />
Description
Launches a specific number of instances of an AMI (Amazon Machine Image) for which you have permissions.
Practical Usage
Used to launch an instance, which is a copy of the AMI running as a virtual server in the cloud. An AMI is a special type of virtual appliance which is used to create a virtual machine within the Amazon Elastic Compute Cloud. It serves as the basic unit of deployment for services delivered using EC2. Your instance keeps running until you stop or terminate it, or until it fails. If an instance fails, you can launch a new one from the AMI.
Parameters
Connection
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Connection | --- | --- | --- | --- | Indicates
where user credentials and preferences originate from.
This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes. The available options
are:
|
Session | Text | Yes, if the connection is set to Session | EC2Session1 | SESSION="EC2Session1" | The name of an existing session to attach this activity to. This parameter is active only if the Connection parameter is set to Session. |
Access key | Text | Yes, if the connection is set to Host | (Empty) | ACCESSKEY="022QF06E7MXBSH9DHM02" | A 20-character alphanumeric string that uniquely identifies the owner of the AWS service account, similar to a username. This key along with a corresponding secret access key forms a secure information set that AWS uses to confirm a valid user's identity. This parameter is active only if the Connection parameter is set to Host. |
Secret access key | Text | Yes, if the connection is set to Host | (Empty) | SECRETKEY="kWcrlUX5JEDGM/LtmEENI/aVmYvHNif5zB+d9+ct" | A 40-character string that serves the role as password to access the AWS service account. This along with an associated access key forms a secure information set that EC2 uses to confirm a valid user's identity. This parameter is active only if the Connection parameter is set to Host. |
User agent | Text | No | Automate | USERAGENT="Automate" | The name of the client or application initiating requests to AWS. The default value is 'Automate'. |
Maximum number of retries on error | Number | No | (Empty) | MAXERRORRETRY="4" | The total amount of instances this activity should retry the request before returning an error. Network components can generate errors anytime in the life of a request, thus, implementing retries can increase reliability. |
Service URL | Text | No | (Empty) | SERVICEURL="https://ec2.eu-west-1.amazonaws.com" | The URL that provides the service endpoint. To make the service call to a different region, you can pass the region-specific endpoint URL. For example, entering https://ec2.us-west-1.amazonaws.com points to US West (Northern California) region. A complete list of EC2 regions, accompanying endpoints and valid protocols can be found below under EC2 Regions and Endpoints. |
Proxy host | Text | No | (Empty) | PROXYHOST="proxy.host.com" | The host name (for example, server.domain.com) or IP address (for example, xxx.xxx.xxx.xxx) of the proxy server to use when connecting to AWS. |
Proxy port | Number | No | (Empty) | PROXYPORT="1028" | The port number to use to connect to the proxy server. |
Proxy username | Text | No | (Empty) | PROXYUSERNAME="Username" | The username to authenticate with the proxy server. |
Proxy password | Text | No | (Empty) | PROXYPWD="encrypted" | The password to authenticate with the proxy server. |
Signature method | Text | No | (Empty) | SIGNMETHOD="HmacSHA256" | The signature method to use for signing the request. This provides a valid hashing algorithm for signature calculation. Valid AWS signature methods are HmacSHA1 and HmacSHA256. |
Signature version | Number | No | (Empty) | SIGNVERSION="2" | The signature version for signing the request. Valid AWS signature versions are 2 and 4. The difference with version 4 is that it allows you to sign your message using a key that is derived from your secret access key rather than using the secret access key itself. |
Instance
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Image ID | Text (Options) | Yes | (Empty) |
|
The
unique ID of a machine image. Use the Amazon EC2 - List
images activity to gather a list of images. The available
options are:
|
Instance type | Text (Options) | Yes | (Empty) |
|
The
size of the instance to launch. Larger instance types have more
CPU and memory. The available options are:
|
Security group | Text | Yes | (Empty) | SECURITYGROUP="LinuxGroup" | The name of the security group. A security group is a named collection of access rules that specify which incoming network traffic should be delivered to your instance. Use the Amazon EC2 - Create security group activity to create a new security group. |
Key pair name | Text | Yes | (Empty) | KEYPAIR="websvr-keypair" | The name of the key pair (Example: -k websvr-keypair). |
Availability zone | Text (Options) | Yes | No preference |
|
The
zone in which to launch the instances. The available options
are:
|
Number of instances | Number | Yes | 1 | TOTALINSTANCES="3" | The
number of instances based on the selected AMI to launch. The default
value is 1. NOTE: If Amazon EC2 cannot launch the specified number of instances,
no instances will launch. |
Create and populate dataset with instance information | Text | No | (Empty) | RESULTDATASET="datasetname"
|
The name of a dataset to create and populate with information regarding the launched instances. More details regarding the fields that this dataset creates can be found below under Datasets. |
Advanced
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Kernel ID | Text | No | (Empty) | KERNELID="aki-ba3adfd3" | The unique ID of the kernel with which to launch the instance (Example: kernel aki-ba3adfd3). |
RAM disk ID | Text | No | (Empty) | RAMDISKID="ari-abcdef01" | The unique ID of the RAM disk to select (Example: ari-abcdef01). Some kernels require additional drivers at launch. Check the kernel requirements for information on whether you need to specify a RAM disk. |
User data | Text | No | (Empty) | USERDATA="user-data.txt" | Specifies Base64-encoded MIME user data to be made available to the instances in this reservation. |
Subnet ID | Text | No | (Empty) | SUBNETID="subnet-f3e6ab83" | Specifies the Amazon VPC subnet ID within which to launch the instances for Amazon Virtual Private Cloud. |
Enable cloud watch monitoring | Yes/No | No | No | MONITORING="yes" | If selected, enables monitoring for the instance (disabled by default). |
Additional Notes
EC2 Regions and Endpoints
This table contains a complete list of EC2 endpoints, accompanying regions and supported protocols.
Endpoint | Region | Protocol |
---|---|---|
ec2.us-east-1.amazonaws.com | US East (Northern Virginia) Region | HTTP and HTTPS |
ec2.us-west-2.amazonaws.com | US West (Oregon) Region | HTTP and HTTPS |
ec2.us-west-1.amazonaws.com | US West (Northern California) Region | HTTP and HTTPS |
ec2.eu-west-1.amazonaws.com | EU (Ireland) Region | HTTP and HTTPS |
ec2.ap-southeast-1.amazonaws.com | Asia Pacific (Singapore) Region | HTTP and HTTPS |
ec2.ap-southeast-2.amazonaws.com | Asia Pacific (Sydney) Region | HTTP and HTTPS |
ec2.ap-northeast-1.amazonaws.com | Asia Pacific (Tokyo) Region | HTTP and HTTPS |
ec2.sa-east-1.amazonaws.com | South America (Sao Paulo) Region | HTTP and HTTPS |
Datasets
A dataset is a multiple column, multiple row container object. This activity creates and populates a dataset containing a specific set of fields in addition to the standard dataset fields. The table below describes these fields (assuming the dataset assigned is named "theDataset").
Name | Type | Return Value |
---|---|---|
theDataset.PublicIp | Text | Returns the public IP address assigned to your account (elastic IP address). |
theDataset.InstanceId | Text | Returns the instance ID associated to the public IP address. |
Example
- The sample AML code below can be copied and pasted directly into the Steps Panel of the Task Builder.
- Parameters containing user credentials, files, file paths, and/or other information specific to the task must be customized before the sample code can run successfully.
Description
This sample task launches an Amazon EC2 instance.
<AMAWSEC2 IMAGEID="ami-b232d0db" INSTANCETYPE="m1.small" KEYPAIR="websvr-keypair" SECURITYGROUP="LinuxGroup" ZONE="No Preference" />