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

💖 VM::EC2::DB::Instance — the RDS baddie 💖

okay bestie, so this page is from the User Contributed Perl Documentation collection, and the module we're talking about is VM::EC2::DB::Instance. Manual page name is VM::EC2::DB::Instance(3pm), if you're the type who needs receipts. It's a Perl module, it's iconic, let's get into it. ✨

---

🌸 NAME 🌸

VM::EC2::DB::Instance — the object that describes an Amazon RDS instance. That's it, that's the whole vibe. 🎀

---

✨ SYNOPSIS ✨

like, here's how you actually use it, no cap:

use VM::EC2;

$ec2      = VM::EC2->new(...);
$db = $ec2->describe_db_instances('mydbinstance');

$auto_upgrade = $db->AutoMinorVersionUpgrade;
$az = $db->AvailabilityZone;
$bkup_days = $db->BackupRetentionPeriod;
$charset = $db->CharacterSetName;
$class = $db->DBInstanceClass;
$status = $db->DBInstanceStatus;
$db_name = $db->DBName;
@parm_grps = $db->DBParameterGroups;
@sec_grps = $db->DBSecurityGroups;
@subnet_grps = $db->DBSecurityGroups;
$endpt = $db->Endpoint;
$engine = $db->Engine;
$version = $db->EngineVersion;
$create_time = $db->InstanceCreateTime;
$iops = $db->Iops;
$latest_restorable_time = $db->LatestRestorableTime;
$license = $db->LicenseModel;
$user = $db->MasterUsername;
$multi_az = $db->MultiAZ;
@option_grp_memberships = $db->OptionGroupMemberships;
@pending_vals = $db->PendingModifiedValues;
$backup_window = $db->PreferredBackupWindow;
$maint_window = $db->PreferredMaintenanceWindow;
$publicly_accessible = $db->PubliclyAccessible;
@ids = $db->ReadReplicaDBInstanceIdentifiers;
$id = $db->ReadReplicaSourceDBInstanceIdentifier;
$sec_zone = $db->SecondaryAvailabilityZone;
@vpc_grps = $db->VpcSecurityGroups;

literally just call the method, get the value, move on with your day. slay. 💅

---

🦋 DESCRIPTION 🦋

So this object is an Amazon RDS DB instance. Like, it's the whole representation of one. You get one back when you call VM::EC2->describe_db_instances(). 🫶

And it's not just a read-only little guy — besides all the methods for querying the instance's attributes, there are also methods that let you manage the instance's lifecycle, which means starting it, stopping it, and terminating it. full main character energy fr fr. 🔥

---

👑 METHODS 👑

💫 LIFECYCLE METHODS 💫

okay so here's the tea, and it's a lil weird: there is no concept of 'stopping' an RDS instance other than deletion. yeah. that's just how RDS is built, bestie. In that sense, an RDS instance is much different than an EC2 instance — do not come in here expecting the same rules, you will be humbled. 😭

Rebooting is possible though, and ngl it's the only means to apply some changes to the database. so if you're like "why is my change not showing up", reboot. that's the move. ⭐

🧚 STRING OVERLOADING 🧚

When you use this object in a string context, it will interpolate the DBInstanceIdentifier. that's it. put it in quotes, get the identifier, iykyk. 💜

---

🌈 SEE ALSO 🌈

• VM::EC2
• VM::EC2::Generic

go read those too, they're the supporting cast and honestly they ate. 🍓

---

🎀 AUTHOR 🎀

Lance Kinley <lkinley@loyaltymethods.com>.

Copyright (c) 2013 Loyalty Methods, Inc.

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.

okay the legal bit is long but it matters — free software, GPL or Artistic License 2.0, your choice, and yes there's a disclaimer of warranty, so read the files, bestie. 🫶

---

and that's the whole page!! ✨ this doc shipped with perl v5.38.2, dated 2024-08-10, and it's the VM::EC2::DB::Instance(3pm) manual page. bye pookie, go describe some db instances 💖🌸💅