|
Amazon EC2 - Attach volume |
Declaration
<AMAWSEC2 ACTIVITY="attach_volume" 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" VOLUMEID="text" INSTANCEID="text" DEVICE="text" />
Description
Attaches an Amazon EBS (Elastic Block Store) volume to a running instance and exposes it as the specified device.
Practical Usage
Commonly used to attach a previously created EBS volume to an instance. Once you've created an EBS Volume, the next logical step is to attach it to an instance. Amazon EBS provides block level storage volumes for use with EC2 instances. EBS volumes are off-instance storage units that persists independently from the life of an instance. Elastic Block Store provides highly reliable storage volumes that can be attached to a running EC2 instance and exposed as a device within the instance.
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. |
Volume
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Volume ID | Text | Yes | (Empty) | VOLUMEID="vol-0753f76e" | The unique ID of the Amazon EBS volume to attach. In order to initiate a proper attachment, the volume and instance must be within the same availability zone and the instance must be running. |
Instance ID | Text | Yes | (Empty) | INSTANCEID="i-5789393c" | The unique ID of the instance to which the volume attaches. In order to initiate a proper attachment, the volume and instance must be within the same availability zone and the instance must be running. |
Device | Text | Yes | (Empty) | DEVICE="/dev/sda2" | Specifies how the device is exposed to the instance (for example, /dev/sdh). For a complete list of all device names available on Amazon EC2, see the Device Names table below. You can specify these names when attaching a volume to a running instance. |
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 |
Device Names
This table lists all of the device names available on Amazon EC2.
Instance Type | Possible for Connection | Reserved for Root | Instance Store Volumes | Recommended for Connection |
---|---|---|---|---|
Linux / UNIX | /dev/sd[a-z] /dev/sd[a-z][1-15] /dev/hd[a-z] /dev/hd[a-z][1-15] |
/dev/sda1 | /dev/sd[b-e] | /dev/sd[f-p] /dev/sd[f-p][1-6] |
Windows | xvd[a-p] /dev/sda[1-2] /dev/sd[b-e] |
/dev/sda1 | xvd[a-e] | xvd[f-p] |
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 attaches an Amazon EBS volume to an instance.
<AMAWSEC2 ACTIVITY="attach_volume" VOLUMEID="vol-0753f76e" INSTANCEID="i-5789393c" DEVICE="/dev/sda2" />