logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

VM::EC2::DB::Instance - Object describing an Amazon RDS instance

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.

perl v5.38.2                                       2024-08-10                         VM::EC2::DB::Instance(3pm)

Description

       This object represents an Amazon RDS DB instance, and is returned by VM::EC2->describe_db_instances(). In
       addition to methods to query the instance's attributes, there are methods that allow you to manage the
       instance's lifecycle, including start, stopping, and terminating it.

Lifecycle Methods

       There is no concept of 'stopping' an RDS instance other than deletion.  In this sense an RDS instance is
       much different than an EC2 instance.  Rebooting is possible and the only means to apply some changes to
       the database.

Methods

Name

       VM::EC2::DB::Instance - Object describing an Amazon RDS instance

See Also

       VM::EC2 VM::EC2::Generic

String Overloading

       When used in a string context, this object will interpolate the DBInstanceIdentifier.

Synopsis

         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;

See Also