VM::EC..._group(3pm)

✨ VM::EC2::REST::placement_group 💅

okay bestie, so this is a page from the User Contributed Perl Documentation collection — it's the manual for VM::EC2::REST::placement_group, aka the bit of the VM::EC2 toolkit that deals with placement groups on AWS. no cap, it's shorter than it sounds. let's get into it 🫶

---

🌸 NAME 🌸

VM::EC2::REST::placement_group — Placement groups 💖

---

🎀 SYNOPSIS 🎀

use VM::EC2 ':hpc'

that's it. that's the whole synopsis. one line. she's concise, she's iconic, she ate. 👑

---

🦋 METHODS 🦋

okay so here's the tea: placement groups give you low latency and high-bandwidth connectivity between cluster instances, and they do it within a single Availability Zone. the move is: create a placement group, then launch your cluster instances into it. instances that get launched inside a placement group participate in a full-bisection bandwidth cluster — which is literally exactly what you want for HPC applications. no cap, that's the whole point. 💅

here's what's Implemented:

• CreatePlacementGroup
• DeletePlacementGroup
• DescribePlacementGroups

---

⭐ @groups = $ec2->describe_placement_groups(@group_names)

⭐ @groups = $ec2->describe_placement_groups(\%filters)

⭐ @groups = $ec2->describe_placement_groups(-group_name=>\@ids,-filter=>\%filters)

this method hands you back the deets on your cluster placement groups, as a list of VM::EC2::PlacementGroup objects. 🎁

Optional arguments:

• -group_name — a scalar or an arrayref of placement group names. whatever vibes you're feeling.
• -filter — tags and other filters to apply. 🧚

the filters available are described fully at: http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference-query-DescribePlacementGroups.html

and the actual filter names are:

• group-name
• state
• strategy

---

💜 $success = $ec2->create_placement_group($group_name)

💜 $success = $ec2->create_placement_group(-group_name=>$name,-strategy=>$strategy)

creates a placement group that cluster instances get launched into. 🚀

Required arguments:</purl>

• -group_name — the name of the placement group to create

Optional:

• -strategy — as of 2012-12-23, the only available option is 'cluster', so the parameter defaults to that. iykyk. 💀

returns true on success. periodt.

---

🌈 $success = $ec2->delete_placement_group($group_name)

🌈 $success = $ec2->delete_placement_group(-group_name=>$group_name)

deletes a placement group from the account. bye bestie, you will not be missed 😭 (jk jk, but fr, she's gone).

Required arguments:

• -group_name — the name of the placement group to delete

returns true on success. ✨

---

👀 SEE ALSO 👀

• VM::EC2

---

💖 AUTHOR 💖

Lincoln Stein <lincoln.stein@gmail.com>. 🫶

Copyright (c) 2011 Ontario Institute for Cancer Research

This package and its accompanying libraries is free software; you can redistribute it and/or modify it under the terms of the GPL (either version 1, or at your option, any later version) or the Artistic License 2.0. Refer to LICENSE for the full license text. In addition, please see DISCLAIMER.txt for disclaimers of warranty.

---

and that's the whole page, bestie 💅 go forth and cluster your instances responsibly. no notes. 👑

this has been perl v5.38.2 energy, dated 2024-08-10, in the VM::EC..._group(3pm) era — mwah 🎀✨