|
|
Amazon EC2 - Detach volume |
Declaration
<AMAWSEC2 ACTIVITY="detach_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" FORCE="YES/NO" />
Description
Detaches an EBS (Elastic Block Store) volume from an instance.
IMPORTANT: All EC2 activities are performed
using Amazon's EC2 engine and rely on a valid Amazon EC2 service
account in order to function correctly.
Practical Usage
Mainly used to detach an EBS volume from an instance in order to delete that volume. By default, you cannot delete an EBS Volume unless it is currently detached from a running instance. If an EBS volume is the root device of an instance, it cannot be detached while the instance is in the ‘running’ state. To detach the root volume, stop the instance first. Also, make sure to un-mount any file systems on the device within your operating system before detaching the volume. Failure to un-mount file systems, or otherwise properly release the device from use, can result in lost data and will corrupt the file system.
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="4282672b" | The ID of the volume to detach. |
| Instance ID | Text | No | (Empty) | INSTANCEID="6058a509" | The ID of the instance. |
| Device | Text | No | (Empty) | DEVICE="/dev/sdh" | The device name. |
| Force | Yes/No | No | No | FORCE="YES" | If selected, forces detachment if the previous detachment attempt did not occur cleanly. This can lead to data loss or a corrupted file system. Enable this option only as a last resort to detach a volume from a failed instance. The instance will not have an opportunity to flush file system caches nor file system metadata. If you enable this option, you must perform file system check and repair procedures. The default value is NO. |
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 |
Example
NOTE:
- 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 detaches an Amazon EBS volume.
Copy
<AMAWSEC2 ACTIVITY="detach_volume" VOLUMEID="vol-0753f76e" />