1VM::EC2::REST::relationUasle_rdaCtoanbtarsiebV_uMst:ee:rdEvCiP2ce:er:(lR3E)DSoTc:u:mreenltaattiioonnal_database_service(3)
2
7 use VM::EC2 ':rds';
8
10 These methods give access and control over the AWS Relational Database
11 Service. RDS provides easy access to creating and managing an Oracle
12 or MySQL database in the AWS cloud.
13 Implemented: AddSourceIdentifierToSubscription AddTagsToResource
15 AuthorizeDBSecurityGroupIngress CopyDBSnapshot CreateDBInstance
16 CreateDBInstanceReadReplica CreateDBParameterGroup
17 CreateDBSecurityGroup CreateDBSnapshot CreateDBSubnetGroup
18 CreateEventSubscription CreateOptionGroup DescribeDBEngineVersions
19 DescribeDBInstances DescribeDBParameterGroups DescribeDBParameters
20 DescribeDBSecurityGroups DescribeDBSnapshots DescribeDBSubnetGroups
21 DescribeEngineDefaultParameters DescribeEventCategories
22 DescribeEventSubscriptions DescribeEvents DescribeOptionGroupOptions
23 DescribeOptionGroups DescribeOrderableDBInstanceOptions
24 DescribeReservedDBInstances DescribeReservedDBInstancesOfferings
25 DownloadDBLogFilePortion ListTagsForResource ModifyDBInstance
26 ModifyDBParameterGroup ModifyDBSubnetGroup ModifyEventSubscription
27 ModifyOptionGroup PromoteReadReplica
28 PurchaseReservedDBInstancesOffering RebootDBInstance
29 RemoveSourceIdentifierFromSubscription RemoveTagsFromResource
30 ResetDBParameterGroup RestoreDBInstanceFromDBSnapshot
31 RestoreDBInstanceToPointInTime RevokeDBSecurityGroupIngress
32 Unimplemented:
34 (none)
35
37 VM::EC2
38 $ec2->add_source_identifier_to_subscription(%args)
40 Adds a source identifier to an existing RDS event notification
41 subscription.
42 Required arguments:
44 -source_identifier The identifier of the event source to be added.
46 -subscription_name The name of the RDS event notification subscription you want
48 to add a source identifier to.
49 Returns a VM::EC2::DB::Event::Subscription object.
51 $ec2->add_tags_to_resource(-resource_name => $name, -tags => \@tags)
53 Adds metadata tags to an Amazon RDS resource. These tags can also be
54 used with cost allocation reporting to track costs associated with
55 Amazon RDS resources, or used in a Condition statement in an IAM policy
56 for Amazon RDS.
57 Required arguments:
59 -resource_name The Amazon RDS resource the tags will be removed from. This value is an Amazon
61 Resource Name (ARN). For information about creating an ARN, see Constructing
62 an RDS Amazon Resource Name (ARN) at:
63 http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN
64 -tags hashref or arrayref of hashrefs containing tag Key/Value pairs
66 This method does not return a value but will raise an error if
68 unsuccessful.
69 $sg = $ec2->authorize_db_security_group_ingress(%args)
71 Enables ingress to a DBSecurityGroup using one of two forms of
72 authorization. First, EC2 or VPC security groups can be added to the
73 DBSecurityGroup if the application using the database is running on EC2
74 or VPC instances. Second, IP ranges are available if the application
75 accessing your database is running on the Internet.
76 Required arguments:
78 -db_security_group_name The name of the DB Security Group to add authorization to.
80 Optional arguments:
82 -cidrip The IP range to authorize.
84 -ec2_security_group_id ID of the EC2 Security Group to authorize. For VPC DB
86 security groups, EC2SecurityGroupId must be provided.
87 -ec2_security_group_name Name of the EC2 Security Group to authorize.
89 -ec2_security_group_owner_id AWS Account Number of the owner of the EC2 Security Group
91 specified in the -ec2_security_group_name parameter.
92 Returns a VM::EC2::DB::SecurityGroup object.
94 $snapshot = $ec2->copy_db_snapshot(-source_db_snapshot_identifier =>
96 $db_id, -target_db_snapshot_identifier => $snap_id)
97 Copies the specified DBSnapshot. The source DBSnapshot must be in the
98 "available" state.
99 Required arguments:
101 -source_db_snapshot_identifier The identifier for the source DB snapshot.
103 Constraints:
104 * Must specify a valid system snapshot in
105 the "available" state
106 * If the source snapshot is in the same
107 region as the copy, specify a valid DB
108 snapshot identifier
109 * If the source snapshot is in a different
110 region than the copy, specify a valid DB
111 snapshot ARN
112 For more information, see:
113 http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html
114 -target_db_snapshot_identifier The identifier for the copied snapshot.
116 Constraints:
117 * Cannot be null, empty, or blank
118 * Must contain from 1 to 255 alphanumeric
119 characters or hyphens
120 * First character must be a letter
121 * Cannot end with a hyphen or contain two
122 consecutive hyphens
123 -source Alias for -source_db_snapshot_identifier
125 -target Alias for -target_db_snapshot_identifier
127 Optional arguments:
129 -tags hashref or arrayref of hashrefs containing Key/Value pairs
131 Returns a VM::EC2::DB::Snapshot object.
133 $instance = $ec2->create_db_instance(%args)
135 Creates a new DB instance.
136 Required arguments:
138 -allocated_storage MySQL:
140 * Must be an integer from 5 to 1024.
141 Oracle:
142 * Must be an integer from 10 to 1024.
143 SQL Server:
144 * Must be an integer from 200 to 1024
145 (Standard Edition and Enterprise Edition)
146 or from 30 to 1024 (Express Edition and
147 Web Edition)
148 -db_instance_class The compute and memory capacity of the DB Instance.
150 db.t1.micro | db.m1.small | db.m1.medium | db.m1.large |
151 db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge
152 -db_instance_identifier The DB Instance identifier. This parameter is stored as a
154 lowercase string.
155 Constraints:
156 * Must contain from 1 to 63 alphanumeric characters or
157 hyphens (1 to 15 for SQL Server).
158 * First character must be a letter.
159 * Cannot end with a hyphen or contain two consecutive
160 hyphens.
161 -engine The name of the database engine to be used for this
163 instance.
164 Valid values: MySQL | oracle-se1 | oracle-se | oracle-ee |
165 sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web
166 -master_user_password The password for the master database user. Can be any
168 printable ASCII character except "/", "\", or "@".
169 Constraints:
170 * MySQL: Must contain from 8 to 41 alphanumeric characters.
171 * Oracle: Must contain from 8 to 30 alphanumeric characters.
172 * SQL Server: Must contain from 8 to 128 alphanumeric
173 characters.
174 -master_username The name of master user for the client DB Instance.
176 Constraints:
178 * First character must be a letter.
179 * Cannot be a reserved word for the chosen database engine.
180 MySQL:
181 * Must be 1 to 16 alphanumeric characters.
182 Oracle:
183 * Must be 1 to 30 alphanumeric characters.
184 SQL Server:
185 * Must be 1 to 128 alphanumeric characters.
186 Optional arguments:
188 -auto_minor_version_upgrade Indicates that minor engine upgrades will be applied
190 automatically to the DB Instance during the maintenance
191 window. (Boolean). Default: true
192 -availability_zone The EC2 Availability Zone that the database instance will
194 be created in.
195 Default: A random, system-chosen Availability Zone in the
196 endpoint's region.
197 -backup_retention_period The number of days for which automated backups are retained.
199 Setting this parameter to a positive number enables backups.
200 Setting this parameter to 0 disables automated backups.
201 Default: 1
202 Constraints:
203 * Must be a value from 0 to 8
204 * Cannot be set to 0 if the DB Instance is a master instance
205 with read replicas
206 -character_set_name For supported engines, indicates that the DB Instance should
208 be associated with the specified CharacterSet.
209 -db_name The meaning of this parameter differs according to the
211 database engine you use.
212 MySQL:
214 The name of the database to create when the DB Instance
215 is created. If this parameter is not specified, no database
216 is created in the DB Instance.
217 Constraints:
219 * Must contain 1 to 64 alphanumeric characters
220 * Cannot be a reserved word
221 Oracle:
223 The Oracle System ID (SID) of the created DB Instance.
224 Constraints:
226 * Cannot be longer than 8 characters
227 SQL Server:
229 Not applicable. Must be null.
230 -db_parameter_group_name The name of the DB Parameter Group to associate with this
232 DB instance. If this argument is omitted, the default
233 DBParameterGroup for the specified engine will be used.
234 Constraints:
236 * Must be 1 to 255 alphanumeric characters
237 * First character must be a letter.
238 * Cannot end with a hyphen or contain two consecutive
239 hyphens
240 -db_security_groups An arrayref of DB Security Groups to associate with the
242 instance
243 -db_subnet_group_name A DB Subnet Group to associate with this DB Instance.
245 If not specified, then it is a non-VPC DB instance.
246 -engine_version The version number of the database engine to use.
248 -iops The amount of Provisioned IOPS initially allocated.
250 Integer between 100-1000
251 -license_model License model information for this DB Instance.
253 Valid values: license-included |
254 bring-your-own-license |
255 general-public-license
256 -multi_az Specifies if the DB Instance is a Multi-AZ deployment.
258 You cannot set the -availability_zone argument if the
259 -multi_az argument is set to true.
260 -option_group_name Indicates that the DB Instance should be associated
262 with the specified option group.
263 -port The port number on which the database accepts
265 connections.
266 MySQL:
268 * Default: 3306, Valid values: 1150-65535
269 Oracle:
270 * Default: 1521, Valid values: 1150-65535
271 Oracle:
272 * Default: 1433, Valid values: 1150-65535 except
273 1434 and 3389.
274 -preferred_backup_window The daily time range during which automated backups are
276 created if automated backups are enabled using the
277 -backup_retention_period argument.
278 Default: Default: A 30-minute window selected at random
280 from an 8-hour block of time per region. The following
281 list shows the time blocks for each region from which
282 the default backup windows are assigned.
283 * US-East (Northern Virginia) Region: 03:00-11:00 UTC
285 * US-West (N. California, Oregon) Region: 06:00-14:00 UTC
286 * EU (Ireland) Region: 22:00-06:00 UTC
287 * Asia Pacific (Singapore) Region: 14:00-22:00 UTC
288 * Asia Pacific (Tokyo) Region: 17:00-03:00 UTC
289 Constraints:
291 * Must be in the format hh24:mi-hh24:mi
292 * Times in Universal Time Coordinated (UTC).
293 * Must not conflict with the preferred maintenance window.
294 * Must be at least 30 minutes.
295 -preferred_maintenance_window The weekly time range (in UTC) during which system
297 maintenance can occur.
298 Format: ddd:hh24:mi-ddd:hh24:mi
300 Default: A 30-minute window selected at random from an 8-hour
302 block of time per region, occurring on a random day of the
303 week. The following list shows the time blocks for each
304 region from which the default maintenance windows are
305 assigned.
306 * US-East (Northern Virginia) Region: 03:00-11:00 UTC
308 * US-West (N. California, Oregon) Region: 06:00-14:00 UTC
309 * EU (Ireland) Region: 22:00-06:00 UTC
310 * Asia Pacific (Singapore) Region: 14:00-22:00 UTC
311 * Asia Pacific (Tokyo) Region: 17:00-03:00 UTC
312 Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
314 Constraints: Minimum 30-minute window.
315 -publicly_accessible Specifies the accessibility options for the DB instance. A
317 value of true specifies an Internet-facing instance with a
318 publicly resolvable DNS name, which resolves to a public IP
319 address. A value of false specifies an internal instance with
320 a DNS name that resolves to a private IP address.
321 Default: The default behavior varies depending on whether a
323 VPC has been requested or not. The following list shows the
324 default behavior in each case.
325 * DefaultVPC:true
326 * VPC:false
327 If no DB subnet group has been specified as part of the
329 request and the -publicly_accessible value has not been set,
330 the DB instance will be publicly accessible. If a specific DB
331 subnet group has been specified as part of the request and
332 the PubliclyAccessible value has not been set, the DB
333 instance will be private.
334 -tags hashref or arrayref of hashrefs containing Key/Value pairs
336 -vpc_security_group_ids A list of EC2 VPC Security Groups to associate with this
338 DB Instance.
339 This method returns a VM::EC2::DB:Instance object.
341 $instance = $ec2->create_db_instance_read_replica(%args)
343 Creates a DB Instance that acts as a Read Replica of a source DB
344 Instance. All Read Replica DB Instances are created as Single-AZ
345 deployments with backups disabled. All other DB Instance attributes
346 (including DB Security Groups and DB Parameter Groups) are inherited
347 from the source DB Instance, except as specified below. IMPORTANT:
348 The source DB Instance must have backup retention enabled.
349 Required arguments:
351 -db_instance_identifier The DB Instance identifier of the Read Replica. This is the
353 unique key that identifies a DB Instance. This parameter is
354 stored as a lowercase string.
355 -source_db_instance_identifier The identifier of the DB Instance that will act as the source
357 for the Read Replica. Each DB Instance can have up to five
358 Read Replicas. Constraints: Must be the identifier of an
359 existing DB Instance that is not already a Read Replica DB
360 Instance.
361 Optional arguments:
363 -auto_minor_version_upgrade Indicates that minor engine upgrades will be applied
365 automatically to the Read Replica during the maintenance
366 window. (Boolean)
367 -availability_zone The Amazon EC2 Availability Zone that the Read Replica will
369 be created in. Default: A random, system-chosen
370 Availability Zone in the endpoint's region.
371 -db_instance_class The compute and memory capacity of the Read
373 Replica.
374 Valid Values: db.m1.small | db.m1.medium |
375 db.m1.large | db.m1.xlarge | db.m2.xlarge |
376 db.m2.2xlarge | db.m2.4xlarge
377 -iops The amount of Provisioned IOPS to be initially allocated for
379 the DB Instance.
380 -option_group_name The option group the DB instance will be associated with. If
382 omitted, the default Option Group for the engine specified
383 will be used.
384 -port The port number that the DB Instance uses for connections.
386 Default: Inherits from the source instance
387 Valid Values: 1150-65535
388 -publicly_accessible Specifies the accessibility options for the DB instance. A
390 value of true specifies an Internet-facing instance with a
391 publicly resolvable DNS name, which resolves to a public IP
392 address. A value of false specifies an internal instance with
393 a DNS name that resolves to a private IP address.
394 Default: The default behavior varies depending on whether a
396 VPC has been requested or not. The following list shows the
397 default behavior in each case.
398 * DefaultVPC:true
399 * VPC:false
400 If no DB subnet group has been specified as part of the
402 request and the -publicly_accessible value has not been set,
403 the DB instance will be publicly accessible. If a specific DB
404 subnet group has been specified as part of the request and
405 the PubliclyAccessible value has not been set, the DB
406 instance will be private.
407 Returns a VM::EC2::DB::Instance object on success.
409 $group = $ec2->create_db_parameter_group(%args)
411 Creates a new DB Parameter Group.
412 A DB Parameter Group is initially created with the default parameters
414 for the database engine used by the DB Instance. To provide custom
415 values for any of the parameters, you must modify the group after
416 creating it using modify_db_parameter_group(). Once you've created a DB
417 Parameter Group, you need to associate it with your DB Instance using
418 modify_db_instance(). When you associate a new DB Parameter Group with
419 a running DB Instance, you need to reboot the DB Instance for the new
420 DB Parameter Group and associated settings to take effect.
421 Required arguments:
423 -db_parameter_group_family The DB Parameter Group Family name. A DB Parameter Group can
425 be associated with one and only one DB Parameter Group
426 Family, and can be applied only to a DB Instance running a
427 database engine and engine version compatible with that DB
428 Parameter Group Family.
429 -db_parameter_group_name The name of the DB Parameter Group.
431 Constraints:
432 * Must be 1 to 255 alphanumeric characters
433 * First character must be a letter
434 * Cannot end with a hyphen or contain two consecutive hyphens
435 NOTE: This value is stored as a lower-case string.
436 -description The description for the DB Parameter Group.
438 Returns a VM::EC2::DB::Parameter::Group object.
440 $group = $ec2->create_db_security_group(%args)
442 Creates a new DB Security Group. DB Security Groups control access to a
443 DB Instance if not in a VPC.
444 Required arguments:
446 -db_security_group_description The description for the DB Security Group.
448 -db_security_group_name The name for the DB Security Group. This value is stored as a
450 lowercase string.
451 Constraints: Must contain no more than 255
452 alphanumeric characters or hyphens.
453 Must not be "Default".
454 -name Alias for -db_security_group_name
456 -description Alias for -db_security_group_description
458 Returns a VM::EC2::DB::SecurityGroup object.
460 $dbsnap = $ec2->create_db_snapshot(-db_instance_identifier => $db_id,
462 -db_snapshot_identifier => $snap_id)
463 Creates a DB snapshot. The source DB instance must be in "available"
464 state.
465 Required arguments:
467 -db_instance_identifier The DB instance identifier. This is the unique key that
469 identifies a DB instance. This parameter is not case
470 sensitive.
471 Constraints:
473 * Must contain from 1 to 63 alphanumeric
474 characters or hyphens
475 * First character must be a letter
476 * Cannot end with a hyphen or contain two
477 consecutive hyphens
478 -db_snapshot_identifier The identifier for the DB snapshot.
480 Constraints:
482 * Cannot be null, empty, or blank
483 * Must contain from 1 to 255 alphanumeric
484 characters or hyphens
485 * First character must be a letter
486 * Cannot end with a hyphen or contain two
487 consecutive hyphens
488 -db_id Alias for -db_instance_identifier
490 -snapshot_id Alias for -db_snapshot_identifier
492 Returns a VM::EC2::DB::Snapshot object on success.
494 $subnet_group = $ec2->create_db_subnet_group(%args)
496 Creates a new DB subnet group. DB subnet groups must contain at least
497 one subnet in at least two availability zones in the region.
498 Required arguments:
500 -db_subnet_group_description The description for the DB subnet group.
502 -db_subnet_group_name The name for the DB Subnet Group. This value is stored as a
504 lowercase string.
505 Constraints:
507 * Must contain no more than 255 alphanumeric
508 characters or hyphens.
509 * Must not be "Default".
510 -subnet_ids Arrayref of subnet IDs for the subnet group.
512 -description Alias for -db_subnet_group_description
514 -name Alias -db_subnet_group_name
516 Returns a VM::EC2::DB::Subnet::Group object on success.
518 $event_sub = $ec2->create_event_subscription(%args)
520 Creates an RDS event notification subscription. This action requires a
521 topic ARN (Amazon Resource Name) created by either the RDS console, the
522 SNS console, or the SNS API. To obtain an ARN with SNS, you must create
523 a topic in Amazon SNS and subscribe to the topic. The ARN is displayed
524 in the SNS console.
525 You can specify the type of source (SourceType) you want to be notified
527 of, provide a list of RDS sources (SourceIds) that triggers the events,
528 and provide a list of event categories (EventCategories) for events you
529 want to be notified of. For example, you can specify SourceType = db-
530 instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories
531 = Availability, Backup.
532 If you specify both the SourceType and SourceIds, such as SourceType =
534 db-instance and SourceIdentifier = myDBInstance1, you will be notified
535 of all the db-instance events for the specified source. If you specify
536 a SourceType but do not specify a SourceIdentifier, you will receive
537 notice of the events for that source type for all your RDS sources. If
538 you do not specify either the SourceType nor the SourceIdentifier, you
539 will be notified of events generated from all RDS sources belonging to
540 your customer account.
541 Required arguments:
543 -sns_topic_arn The Amazon Resource Name (ARN) of the SNS topic created
545 for event notification. The ARN is created by Amazon SNS
546 when you create a topic and subscribe to it.
547 -subscription_name The name of the subscription.
549 Optional arguments:
551 -enabled Boolean; set to true to activate the subscription, set to
553 false to create the subscription but not active it.
554 -event_categories An arrayref of event categories for a -source_type that
556 you want to subscribe to. You can see a list of the
557 categories for a given -source_type in the Events topic
558 in the Amazon RDS User Guide or by using the
559 describe_event_categories() call.
560 -source_ids An arrayref of identifiers of the event sources for which
561 events will be returned. If not specified, then all
562 sources are included in the response. An identifier must
563 begin with a letter and must contain only ASCII letters,
564 digits, and hyphens; it cannot end with a hyphen or
565 contain two consecutive hyphens.
566 -source_type The type of source that will be generating the events.
568 For example, if you want to be notified of events
569 generated by a DB instance, you would set this parameter
570 to db-instance. if this value is not specified, all
571 events are returned.
572 Valid values: db-instance | db-parameter-group |
574 db-security-group | db-snapshot
575 -name Alias for -subscription_name
577 Returns a VM::EC2::DB::Event::Subscription object on success.
579 $option_grp = $ec2->create_option_group(%args)
581 Creates a new Option Group. You can create up to 20 option groups.
582 Required arguments:
584 -engine_name Specifies the name of the engine that this
586 option group should be associated with.
587 -major_engine_version Specifies the major version of the engine
589 that this option group should be associated
590 with.
591 -option_group_description The description of the option group.
593 -option_group_name Specifies the name of the option group to be
595 created.
596 Constraints:
598 * Must be 1 to 255 alphanumeric characters or
599 hyphens
600 * First character must be a letter
601 * Cannot end with a hyphen or contain two
602 consecutive hyphens
603 -name Alias for -option_group_name
605 -description Alias for -option_group_description
607 Returns a VM::EC2::DB::Option::Group object on success.
609 @versions = $ec2->describe_db_engine_versions(%args)
611 All arguments are optional.
612 -db_parameter_group_family The specific DB Parameter Group family to
614 return details for.
615 -family Alias for -db_parameter_group_family
617 -default_only Return only the default version of the
619 specified engine or engine and major
620 version combination (boolean).
621 -engine Database engine to return.
623 -engine_version Database engine version to return.
625 -list_supported_character_sets List supported charsets (boolean)
627 -marker An optional pagination token provided by a previous
629 request. If specified, the response includes only
630 records after the marker, up to the value specified by
631 -max_records.
632 -max_records The maximum number of records to include in the
634 response. If more records than the max exist,
635 a marker token is included in the response.
636 Returns an array of VM::EC2::DB::Engine::Version objects.
638 @db_instances = $ec2->describe_db_instances(-db_instance_identifier => $id,
640 -marker => $marker, -max_records => $integer)
641 All arguments are optional.
642 -db_instance_identifier The user-supplied instance identifier. If this
644 parameter is specified, only information for the
645 specific DB Instance is returned.
646 -marker An optional pagination token provided by a previous
648 request. If specified, the response includes only
649 records after the marker, up to the value specified by
650 -max_records.
651 -max_records The maximum number of records to include in the
653 response. If more records than the max exist,
654 a marker token is included in the response.
655 -db_instance_id alias for -db_instance_identifier
657 Returns an array of VM::EC2::DB::Instance objects if any exist.
659 @groups = $ec2->describe_db_parameter_groups(-db_parameter_group_name =>
661 $name, -marker => $marker, -max_records => $integer)
662 All arguments are optional.
663 -db_parameter_group_name The name of the DB parameter group to describe.
665 -marker An optional pagination token provided by a previous
667 request. If specified, the response includes only
668 records after the marker, up to the value specified by
669 -max_records.
670 -max_records The maximum number of records to include in the
672 response. If more records than the max exist,
673 a marker token is included in the response.
674 -group_name alias for -db_subnet_group_name
676 Returns an array of VM::EC2::DB::Parameter::Group objects if any exist.
678 @params = $ec2->describe_db_parameters(-db_parameter_group_name => $name,
680 -source => $source, -marker => $marker, -max_records => $integer)
681 Required arguments:
682 -db_parameter_group_name The name of the DB parameter group.
684 Optional arguments:
686 -source The parameter types to return.
688 Valid values: user | system | engine-default
689 Default is all parameter types.
690 -marker An optional pagination token provided by a previous
692 request. If specified, the response includes only
693 records after the marker, up to the value specified by
694 -max_records.
695 -max_records The maximum number of records to include in the
697 response. If more records than the max exist,
698 a marker token is included in the response.
699 Returns an array of VM::EC2::DB::Parameter objects.
701 @groups = $ec2->describe_db_security_groups(-db_security_group_name =>
703 $name, -marker => $marker, -max_records => $integer)
704 All arguments are optional.
705 -db_security_group_name The name of the DB security group.
707 -marker An optional pagination token provided by a previous
709 request. If specified, the response includes only
710 records after the marker, up to the value specified by
711 -max_records.
712 -max_records The maximum number of records to include in the
714 response. If more records than the max exist,
715 a marker token is included in the response.
716 -group_name alias for -db_security_group_name
718 Returns an array of VM::EC2::DB::SecurityGroup objects if any exist.
720 @snapshots = $ec2->describe_db_snapshots(%args)
722 All arguments are optional.
723 -db_instance_identifier A DB Instance Identifier to retrieve the list of DB
725 snapshots for. Cannot be used in conjunction with
726 -db_snapshot_identifier.
727 This parameter is not case sensitive.
728 -db_snapshot_identifier A specific DB Snapshot Identifier to describe.
730 Cannot be used in conjunction with .
731 This value is stored as a lowercase string.
732 -marker An optional pagination token provided by a previous
734 request. If specified, the response includes only
735 records after the marker, up to the value specified by
736 -max_records.
737 -max_records The maximum number of records to include in the
739 response. If more records than the max exist,
740 a marker token is included in the response.
741 -snapshot_type An optional snapshot type for which snapshots will
743 be returned. If not specified, the returned results
744 will include snapshots of all types.
745 -db_instance_id Alias for -db_instance_identifier
747 -db_snapshot_id Alias for -db_snapshot_identifier
749 Returns an array of VM::EC2:DB::Snapshot objects if any exist.
751 @groups = $ec2->describe_db_subnet_groups(-db_subnet_group_name => $name,
753 -marker => $marker, -max_records => $integer)
754 All arguments are optional.
755 -db_subnet_group_name The name of the DB Subnet Group to describe.
757 -marker An optional pagination token provided by a previous
759 request. If specified, the response includes only
760 records after the marker, up to the value specified by
761 -max_records.
762 -max_records The maximum number of records to include in the
764 response. If more records than the max exist,
765 a marker token is included in the response.
766 -group_name alias for -db_subnet_group_name
768 Returns an array of VM::EC2::DB::Subnet::Group objects if any exist.
770 @params = $ec2->describe_engine_default_parameters(%args)
772 Required arguments:
773 -db_parameter_group_family The name of the DB Parameter Group Family.
775 -family Alias for -db_parameter_group_family
777 Returns an array of VM::EC2::DB::Parameter objects.
779 @categories = $ec2->describe_event_categories(-source_type => $type)
781 Optional argument:
782 -source_type The type of source that will be generating the events.
784 Valid values: db-instance | db-parameter-group |
785 db-security-group | db-snapshot
786 Returns an array of VM::EC2::DB::Event::Category objects
788 @subs = $ec2->describe_event_subscriptions(-subscription_name => $name)
790 Optional argument:
791 -subscription_name The name of the RDS event notification subscription.
793 Returns an array of VM::EC2::DB::Event::Subscription object.
795 @events = $ec2->describe_events(%args)
797 All arguments are optional but some conditions apply.
798 -duration The number of minutes to retrieve events for.
800 -end_time The end of the time interval for which to retrieve
802 events, specified in ISO 8601 format.
803 For more information on ISO 8601, visit:
804 http://en.wikipedia.org/wiki/ISO_8601
805 -event_categories A string or arrayref of event categories that trigger
807 notifications for a event notification subscription.
808 -source_identifier The identifier of the event source for which events
810 will be returned. If not specified, then all sources
811 are included in the response.
812 -source_type The event source to retrieve events for. If no value
814 is specified, all events are returned.
815 REQUIRED if -source_identifier is provided.
816 If 'DBInstance', then a DBInstanceIdentifier must be
818 supplied in -source_identifier.
819 If 'DBSecurityGroup', a DBSecurityGroupName must be
821 supplied in -source_identifier.
822 If 'DBParameterGroup', a DBParameterGroupName must be
824 supplied in -source_identifier.
825 If 'DBSnapshot', a DBSnapshotIdentifier must be
827 supplied in -source_identifier.
828 -start_time The beginning of the time interval to retrieve events
830 for, specified in ISO 8601 format.
831 For more information on ISO 8601, visit:
832 http://en.wikipedia.org/wiki/ISO_8601
833 Returns an array of VM::EC2::DB::Event objects.
835 @options = $ec2->describe_option_group_options(-engine_name => $name,
837 -major_engine_version => $version)
838 Describes all available options for a particular database engine.
839 Required arguments:
841 -engine_name Database engine to describe options for.
843 Optional arguments:
845 -major_engine_version If specified, filters the results to include only
847 options for the specified major engine version.
848 Returns an array of VM::EC2::DB::Option::Group::Option objects.
850 @groups = $ec2->describe_option_groups(-engine_name => $name,
852 -major_engine_version => $version, -option_group_name => $og_name)
853 Describes the available option groups.
854 All arguments are optional.
856 -engine_name Database engine to describe options for.
858 -major_engine_version If specified, filters the results to include only
860 options for the specified major engine version.
861 -option_group_name The name of the option group to describe. Cannot
863 be supplied together with -engine_name or
864 -major_engine_version.
865 Returns an array of VM::EC2::DB::Option::Group objects.
867 @options = $ec2->describe_orderable_db_instance_options(%args)
869 Describe the different RDS instances that can be launched.
870 Required arguments:
872 -engine The name of the engine to retrieve DB Instance options
874 for.
875 Optional arguments:
877 -db_instance_class The DB Instance class (size) filter value.
879 -engine_version The engine version filter value.
881 -license_model The license model filter value.
883 -vpc The VPC filter value. (boolean)
885 Returns an array of VM::EC2::DB::Instance::OrderableOption objects.
887 @instances = $ec2->describe_reserved_db_instances(%args)
889 Returns information about reserved DB Instances for the account, or
890 about a specific reserved DB Instance.
891 All arguments are optional:
893 -db_instance_class The DB Instance class (size) filter.
895 -duration The duration filter value, specified in
897 years or seconds.
898 Valid values: 1 | 3 | 31536000 | 94608000
899 -multi_az The Multi-AZ filter value. (boolean)
901 -offering_type The offering type filter value.
903 Valid Values: "Light Utilization" |
904 "Medium Utilization" |
905 "Heavy Utilization"
906 -product_description The product description filter value.
908 -reserved_db_instance_id The reserved DB Instance identifier filter value.
910 -reserved_db_instances_offering_id The offering identifier filter value.
912 Returns an array of VM::EC2::DB::Reserved::Instance objects.
914 @offerings = $ec2->describe_reserved_db_instances_offerings(%args)
916 Lists available reserved DB Instance offerings.
917 All arguments are optional:
919 -db_instance_class The DB Instance class (size) filter.
921 -duration The duration filter value, specified in
923 years or seconds.
924 Valid values: 1 | 3 | 31536000 | 94608000
925 -multi_az The Multi-AZ filter value. (boolean)
927 -offering_type The offering type filter value.
929 Valid Values: "Light Utilization" |
930 "Medium Utilization" |
931 "Heavy Utilization"
932 -product_description The product description filter value.
934 -reserved_db_instance_id The reserved DB Instance identifier filter value.
936 -reserved_db_instances_offering_id The offering identifier filter value.
938 Returns an array of VM::EC2::DB::Reserved::Instance objects.
940 $log = $ec2->download_db_log_file_portion(%args)
942 Downloads the last line of the specified log file.
943 All arguments are optional:
945 -db_instance_identifier The DB Instance class (size) filter.
947 -log_file_name The name of the log file to be downloaded.
949 -marker The pagination token provided in the previous
951 request. If this parameter is specified the
952 response includes only records beyond the marker,
953 up to MaxRecords.
954 -number_of_lines The number of lines remaining to be downloaded.
956 Returns a VM::EC2::DB::LogFilePortion object.
958 %tags = $ec2->list_tags_for_resource(-resource_name => $name)
960 Lists all tags on a DB Instance or Snapshot.
961 Arguments:
963 -resource_name The name of the resource to list tags for.
965 Returns a hash or hashref of tags.
967 $db_instance = $ec2->modify_db_instance(%args)
969 Modify settings for a DB Instance. You can change one or more database
970 configuration parameters by specifying these parameters and the new
971 values in the request.
972 Required arguments:
974 -db_instance_identifier The DB Instance identifier.
976 Optional arguments:
978 -allocated_storage The new storage capacity of the RDS instance. Changing this
980 parameter does not result in an outage and the change is
981 applied during the next maintenance window unless the
982 -apply_immediately parameter is set to true for this request.
983 MySQL:
984 * Must be an integer from 5 to 1024.
985 * Value supplied must be at least 10% greater than the
986 current value. Values that are not at least 10% greater
987 than the existing value are rounded up so that they are
988 10% greater than the current value.
989 Oracle:
990 * Must be an integer from 10 to 1024.
991 * Value supplied must be at least 10% greater than the
992 current value. Values that are not at least 10% greater
993 than the existing value are rounded up so that they are
994 10% greater than the current value.
995 SQL Server:
996 * CANNOT BE MODIFIED
997 -allow_major_version_upgrade Indicates that major version upgrades are allowed. Changing
999 this parameter does not result in an outage and the change is
1000 asynchronously applied as soon as possible.
1001 Constraints: This parameter must be set to true when
1003 specifying a value for the -engine_version argument that is
1004 a different major version than the DB Instance's current
1005 version.
1006 -apply_immediately Specifies whether or not the modifications in this request
1008 and any pending modifications are asynchronously applied as
1009 soon as possible, regardless of the
1010 -preferred_maintenance_window setting for the DB Instance.
1011 If this parameter is passed as false, changes to the DB
1013 Instance are applied on the next reboot_db_instance() call,
1014 the next maintenance reboot, or the next failure reboot,
1015 whichever occurs first. See each parameter to determine when
1016 a change is applied. Default is false.
1017 -auto_minor_version_upgrade Indicates that minor engine upgrades will be applied
1019 automatically to the DB Instance during the maintenance
1020 window. Changing this parameter does not result in an outage
1021 except in the following case and the change is asynchronously
1022 applied as soon as possible. An outage will result if this
1023 parameter is set to true during the maintenance window, and a
1024 newer minor version is available, and RDS has enabled auto
1025 patching for that engine version. (Boolean)
1026 -backup_retention_period The number of days for which automated backups are retained.
1028 Setting this parameter to a positive number enables backups.
1029 Setting this parameter to 0 disables automated backups.
1030 Default: Existing setting
1031 Constraints:
1032 * Must be a value from 0 to 8
1033 * Cannot be set to 0 if the DB Instance is a master instance
1034 with read replicas
1035 -db_instance_class The new compute and memory capacity of the DB Instance.
1037 To determine the available classes, use the
1038 describe_orderable_db_instance_options() call.
1039 Passing a value for this parameter causes an outage during
1041 the change and is applied during the next maintenance window,
1042 unless the -apply_immediately argument is specified as true
1043 for this request.
1044 Valid values:
1046 db.t1.micro | db.m1.small | db.m1.medium | db.m1.large |
1047 db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge
1048 -db_parameter_group_name The name of the DB Parameter Group to apply to this DB Instance.
1050 Changing this parameter does not result in an outage and the
1051 change is applied during the next maintenance window unless the
1052 -apply_immediately argument is set to true for this request.
1053 Default: Existing setting.
1055 Constraints:
1057 * Must be 1 to 255 alphanumeric characters
1058 * First character must be a letter.
1059 * Cannot end with a hyphen or contain two consecutive
1060 hyphens
1061 -db_security_groups An arrayref of DB Security Groups to authorize on this DB
1063 Instance. Changing this parameter does not result in an outage
1064 and the change is asynchronously applied as soon as possible.
1065 -engine_version The version number of the database engine to upgrade to.
1067 Changing this parameter results in an outage and the change is
1068 applied during the next maintenance window unless the
1069 -apply_immediately parameter is set to true for this request.
1070 For major version upgrades, if a nondefault DB Parameter Group is
1072 currently in use, a new DB Parameter Group in the DB Parameter
1073 Group Family for the new engine version must be specified. The
1074 new DB Parameter Group can be the default for that DB Parameter
1075 Group Family.
1076 -iops The new Provisioned IOPS (I/O operations per second) value for
1078 the RDS instance. Changing this parameter does not result in an
1079 outage and the change is applied during the next maintenance
1080 window unless the -apply_immediately argument is set to true for
1081 this request.
1082 Default: Existing setting.
1084 Constraints:
1086 * Value supplied must be at least 10% greater than the current
1087 value. Values that are not at least 10% greater than the
1088 existing value are rounded up so that they are 10% greater than
1089 the current value.
1090 -master_user_password The new password for the master database user. Can be any
1092 printable ASCII character except "/", "\", or "@".
1093 Changing this parameter does not result in an outage and the
1095 change is asynchronously applied as soon as possible. Between the
1096 time of the request and the completion of the request, the
1097 MasterUserPassword element exists in the PendingModifiedValues
1098 element of the operation response.
1099 Constraints:
1101 * MySQL: Must contain from 8 to 41 alphanumeric characters.
1102 * Oracle: Must contain from 8 to 30 alphanumeric characters.
1103 * SQL Server: Must contain from 8 to 128 alphanumeric
1104 characters.
1105 -multi_az Specifies if the DB Instance is a Multi-AZ deployment.
1107 Changing this parameter does not result in an outage and the
1108 change is applied during the next maintenance window unless
1109 the -apply_immediately argument is set to true for this request.
1110 (Boolean)
1111 Constraints:
1113 * Cannot be specified if the DB Instance is a read replica.
1114 -new_db_instance_identifier The new DB Instance identifier for the DB Instance when renaming
1116 a DB Instance. This value is stored as a lowercase string.
1117 Constraints:
1119 * Must contain from 1 to 63 alphanumeric characters or
1120 hyphens (1 to 15 for SQL Server).
1121 * First character must be a letter.
1122 * Cannot end with a hyphen or contain two consecutive
1123 hyphens.
1124 -option_group_name Indicates that the DB Instance should be associated
1126 with the specified option group. Changing this parameter does
1127 not result in an outage except in the following case and the
1128 change is applied during the next maintenance window unless the
1129 -apply_immediately argument is set to true for this request. If
1130 the parameter change results in an option group that enables OEM,
1131 this change can cause a brief (sub-second) period during which
1132 new connections are rejected but existing connections are not
1133 interrupted.
1134 Note that persistent options, such as the TDE_SQLServer option for
1136 Microsoft SQL Server, cannot be removed from an option group while
1137 DB instances are associated with the option group. Permanent options,
1138 such as the TDE option for Oracle Advanced Security TDE, cannot be
1139 removed from an option group, and that option group cannot be removed
1140 from a DB instance once it is associated with a DB instance.
1141 -preferred_backup_window The daily time range during which automated backups are
1143 created if automated backups are enabled using the
1144 -backup_retention_period argument.
1145 Default: Default: A 30-minute window selected at random
1147 from an 8-hour block of time per region. The following
1148 list shows the time blocks for each region from which
1149 the default backup windows are assigned.
1150 * US-East (Northern Virginia) Region: 03:00-11:00 UTC
1152 * US-West (N. California, Oregon) Region: 06:00-14:00 UTC
1153 * EU (Ireland) Region: 22:00-06:00 UTC
1154 * Asia Pacific (Singapore) Region: 14:00-22:00 UTC
1155 * Asia Pacific (Tokyo) Region: 17:00-03:00 UTC
1156 Constraints:
1158 * Must be in the format hh24:mi-hh24:mi
1159 * Times in Universal Time Coordinated (UTC).
1160 * Must not conflict with the preferred maintenance window.
1161 * Must be at least 30 minutes.
1162 -preferred_maintenance_window The weekly time range (in UTC) during which system
1164 maintenance can occur.
1165 Format: ddd:hh24:mi-ddd:hh24:mi
1167 Default: A 30-minute window selected at random from an 8-hour
1169 block of time per region, occurring on a random day of the
1170 week. The following list shows the time blocks for each
1171 region from which the default maintenance windows are
1172 assigned.
1173 * US-East (Northern Virginia) Region: 03:00-11:00 UTC
1175 * US-West (N. California, Oregon) Region: 06:00-14:00 UTC
1176 * EU (Ireland) Region: 22:00-06:00 UTC
1177 * Asia Pacific (Singapore) Region: 14:00-22:00 UTC
1178 * Asia Pacific (Tokyo) Region: 17:00-03:00 UTC
1179 Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
1181 Constraints: Minimum 30-minute window.
1182 -vpc_security_group_ids A list of EC2 VPC Security Groups to associate with this
1184 DB Instance. This change is asynchronously applied as soon
1185 as possible.
1186 This method returns a VM::EC2::DB:Instance object.
1188 $group_name = $ec2->modify_db_parameter_group(-db_parameter_group_name =>
1190 $group, -parameters => \@parms)
1191 Modifies the parameters of a DB Parameter Group.
1192 Note: The immediate method can be used only for dynamic parameters; the
1194 pending-reboot method can be used with MySQL and Oracle DB Instances
1195 for either dynamic or static parameters. For Microsoft SQL Server DB
1196 Instances, the pending-reboot method can be used only for static
1197 parameters.
1198 Required arguments:
1200 -db_parameter_group_name The name of the DB Parameter Group.
1202 Constraints:
1203 * Must be the name of an existing DB Parameter Group
1204 * Must be 1 to 255 alphanumeric characters
1205 * First character must be a letter
1206 * Cannot end with a hyphen or contain two consecutive hyphens
1207 -parameters An arrayref of hashes containing parameter names, values,
1209 and the apply method for the parameter update. At least one
1210 parameter name, value, and apply method must be supplied;
1211 subsequent arguments are optional. A maximum of 20 parameters
1212 may be modified in a single request.
1213 The hash keys must be: ParameterName, ParameterValue, ApplyMethod
1215 ie:
1217 [ { ParameterName => 'db_block_checking',
1218 ParameterValue => 'FULL',
1219 ApplyMethod => 'immediate' } ]
1220 -name Alias for -db_parameter_group_name
1222 Returns the DB Parameter Group name on success.
1224 $subnet_group = $ec2->modify_db_subnet_group(%args)
1226 Modifies an existing DB subnet group. DB subnet groups must contain at
1227 least one subnet in at least two AZs in the region.
1228 Required arguments:
1230 -db_subnet_group_name The name for the DB Subnet Group.
1232 -subnet_ids An arrayref of EC2 Subnet IDs for the DB Subnet Group.
1234 Optional arguments:
1236 -db_subnet_group_description The description for the DB Subnet Group.
1238 Returns VM::EC2::DB::Subnet::Group object on success.
1240 $event_sub = $ec2->modify_event_subscription(%args)
1242 Modifies an existing RDS event notification subscription. Note that you
1243 cannot modify the source identifiers using this call; to change source
1244 identifiers for a subscription, use the
1245 add_source_identifier_to_subscription() and
1246 remove_source_identifier_from_subscription() calls.
1247 Required arguments:
1249 -subscription_name The name of the RDS event notification subscription.
1251 Optional arguments:
1253 -enabled Boolean value; set to true to activate the subscription.
1255 -event_categories An arrayref of event categories for a -source_type to
1257 subscribe to. A list of the categories for a given
1258 -source_type can be seen in the Events topic in the Amazon
1259 RDS User Guide or by using the describe_event_categories()
1260 call.
1261 -sns_topic_arn The Amazon Resource Name (ARN) of the SNS topic created for
1263 event notification. The ARN is created by Amazon SNS when
1264 a topic is created and subscribed to.
1265 -source_type The type of source that will be generating the events.
1267 For example, to be notified of events generated by a DB
1268 instance, set this parameter to db-instance. if this value is
1269 not specified, all events are returned.
1270 Valid values: db-instance | db-parameter-group |
1272 db-security-group | db-snapshot
1273 Returns a VM::EC2::DB::Event::Subscription object on success.
1275 $option_group = $ec2->modify_option_group(%args)
1277 Modifies an existing Option Group.
1278 Required arguments:
1280 -option_group_name The name of the option group to be modified.
1282 Optional arguments:
1284 -apply_immediately Indicates whether the changes should be applied immediately,
1286 or during the next maintenance window for each instance
1287 associated with the Option Group. (Boolean)
1288 -options_to_include An arrayref of hashes containing OptionName and other available
1290 options.
1291 Available options are: DBSecurityGroupMemberships, OptionName,
1293 OptionSettings, Port, VpcSecurityGroupMemberships
1294 OptionName and Port must be provided as scalars.
1296 DBSecurityGroupMemberships, VpcSecurityGroupMemberships must
1297 be provided as arrayrefs.
1298 OptionSettings must be a hashref of Name => Value pairs.
1299 ie:
1301 [ { OptionName => 'OEM',
1302 DBSecurityGroupMemberships => [ 'mygroup' ],
1303 Port => 1158 },
1304 { OptionName => 'NATIVE_NETWORK_ENCRYPTION',
1305 OptionSettings => {
1306 'SQLNET.ENCRYPTION_SERVER' => 'REQUIRED',
1307 'SQLNET.CRYPTO_CHECKSUM_SERVER' => 'REQUIRED' } } ]
1308 -options_to_remove A string or arrayref containing the containing the option(s) to
1311 remove.
1312 ie:
1314 [ 'OEM', 'NATIVE_NETWORK_ENCRYPTION' ]
1315 or
1316 'OEM'
1317 Returns a VM::EC2::DB::Option::Group object on success.
1319 $db_instance = $ec2->promote_read_replica(%args)
1321 Promotes a Read Replica DB Instance to a standalone DB Instance.
1322 Required arguments:
1324 -db_instance_identifier The DB Instance identifier. This value is stored as a
1326 lowercase string.
1327 Constraints:
1329 * Must be the identifier for an existing Read Replica DB
1330 Instance
1331 * Must contain from 1 to 63 alphanumeric characters or
1332 hyphens
1333 * First character must be a letter
1334 * Cannot end with a hyphen or contain two consecutive hyphens
1335 Optional arguments:
1337 -backup_retention_period The daily time range during which automated backups are
1339 created if automated backups are enabled.
1340 -preferred_backup_window The daily time range during which automated backups are
1342 created if automated backups are enabled using the
1343 -backup_retention_period argument.
1344 Default: Default: A 30-minute window selected at random
1346 from an 8-hour block of time per region. The following
1347 list shows the time blocks for each region from which
1348 the default backup windows are assigned.
1349 * US-East (Northern Virginia) Region: 03:00-11:00 UTC
1351 * US-West (N. California, Oregon) Region: 06:00-14:00 UTC
1352 * EU (Ireland) Region: 22:00-06:00 UTC
1353 * Asia Pacific (Singapore) Region: 14:00-22:00 UTC
1354 * Asia Pacific (Tokyo) Region: 17:00-03:00 UTC
1355 Constraints:
1357 * Must be in the format hh24:mi-hh24:mi
1358 * Times in Universal Time Coordinated (UTC).
1359 * Must not conflict with the preferred maintenance window.
1360 * Must be at least 30 minutes.
1361 Returns a VM::EC2::DB::Instance object on success.
1363 $reserved_db = $ec2->purchase_reserved_db_instances_offering(%args)
1365 Purchases a reserved DB Instance offering.
1366 Required arguments:
1368 -reserved_db_instances_offering_id The ID of the Reserved DB Instance offering to purchase.
1370 ie: 438012d3-4052-4cc7-b2e3-8d3372e0e706
1371 Optional arguments:
1373 -db_instance_count The number of instances to reserve. Default: 1
1375 -reserved_db_instance_id Customer-specified identifier to track this reservation.
1377 ie: myreservationID
1378 Returns a VM::EC2::DB::Reserved::Instance object on success.
1380 $db_instance = $ec2->reboot_db_instance(-db_instance_identifier => $id,
1382 -force_failover => $boolean)
1383 Reboots a previously provisioned RDS instance. This API results in the
1384 application of modified DBParameterGroup parameters with ApplyStatus of
1385 pending-reboot to the RDS instance. This action is taken as soon as
1386 possible, and results in a momentary outage to the RDS instance during
1387 which the RDS instance status is set to rebooting. If the RDS instance
1388 is configured for MultiAZ, it is possible that the reboot will be
1389 conducted through a failover. A DBInstance event is created when the
1390 reboot is completed.
1391 Required arguments:
1393 -db_instance_identifier The DB Instance identifier.
1395 Optional arguments:
1397 -force_failover When true, the reboot will be conducted through a MultiAZ
1399 failover.
1400 Constraints:
1402 * You cannot specify true if the instance is not configured
1403 for MultiAZ.
1404 Returns a VM::EC2::DB::Instance object on success.
1406 $event_sub =
1408 $ec2->remove_source_identifier_from_subscription(-source_identifier =>
1409 $id, -subscription_name => $name)
1410 Removes a source identifier from an existing RDS event notification
1411 subscription.
1412 Required arguments:
1414 -source_identifier The source identifier to be removed from the subscription,
1416 such as the DB instance identifier for a DB instance or the
1417 name of a security group.
1418 -subscription_name The name of the RDS event notification subscription to remove
1420 a source identifier from.
1421 Returns a VM::EC2::DB::Event::Subscription object on success.
1423 $ec2->remove_tags_from_resource(-resource_name => $name, -tags => \@tags)
1425 Remove metadata tags from a resource.
1426 Required arguments:
1428 -resource_name The Amazon RDS resource the tags will be removed from. This value is an Amazon
1430 Resource Name (ARN). For information about creating an ARN, see Constructing
1431 an RDS Amazon Resource Name (ARN) at:
1432 http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN
1433 -tags hashref or arrayref of hashrefs containing tag Key/Value pairs
1435 This method does not return a value but will raise an error if
1437 unsuccessful.
1438 $name = $ec2->reset_db_parameter_group(%args)
1440 Modifies the parameters of a DB parameter group to the engine/system
1441 default value. To reset specific parameters, submit a hashref of the
1442 following: ParameterName and ApplyMethod. To reset the entire DB
1443 parameter group, set the -reset_all_parameters argument to true. When
1444 resetting the entire group, dynamic parameters are updated immediately
1445 and static parameters are set to pending-reboot to take effect on the
1446 next DB instance restart or after issuing a reboot_db_instance().
1447 Required arguments:
1449 -db_parameter_group_name The name of the DB Parameter Group.
1451 Constraints:
1452 * Must be the name of an existing DB Parameter Group
1453 * Must be 1 to 255 alphanumeric characters
1454 * First character must be a letter
1455 * Cannot end with a hyphen or contain two consecutive hyphens
1456 Conditional arguments:
1458 -parameters An arrayref of hashes containing parameter names and the apply
1460 method for the parameter update.
1461 The hash keys must be: ParameterName and ApplyMethod
1463 ie:
1464 [ { ParameterName => 'max_user_connections',
1465 ApplyMethod => 'pending-reboot' },
1466 { ParameterName => 'max_allowed_packet',
1467 ApplyMethod => 'immediate' } ]
1468 -reset_all_parameters Reset all parameters in the DB parameter group to default
1470 values. Boolean, default is true.
1471 Returns the name of the DB parameter group.
1473 $db_instance = $ec2->restore_db_instance_from_db_snapshot(%args)
1475 Creates a new DB instance from a DB snapshot. The target database is
1476 created from the source database restore point with the same
1477 configuration as the original source database, except that the new RDS
1478 instance is created in the default security group.
1479 Required arguments:
1481 -db_instance_identifier The DB Instance identifier.
1483 Constraints:
1484 * Must contain from 1 to 63 alphanumeric characters or
1485 hyphens (1 to 15 for SQL Server).
1486 * First character must be a letter.
1487 * Cannot end with a hyphen or contain two consecutive
1488 hyphens.
1489 -db_snapshot_identifier The identifier for the DB snapshot.
1491 Constraints:
1493 * Must contain 1 to 255 alphanumeric characters or hyphens
1494 * First character must be a letter
1495 * Cannot end with a hyphen or contain two consecutive hyphens
1496 Optional arguments:
1498 -auto_minor_version_upgrade Indicates that minor engine upgrades will be applied
1500 automatically to the DB Instance during the maintenance
1501 window. (Boolean). Default: true
1502 -availability_zone The EC2 Availability Zone that the database instance will
1504 be created in.
1505 Default: A random, system-chosen Availability Zone in the
1506 endpoint's region.
1507 Constraint: Cannot specify if -multi_az is true
1508 -db_instance_class The compute and memory capacity of the DB Instance.
1510 db.t1.micro | db.m1.small | db.m1.medium | db.m1.large |
1511 db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge
1512 -db_name The database name for the restored DB instance.
1514 NOTE: Does not apply to MySQL engine.
1515 -db_subnet_group_name A DB Subnet Group to associate with this DB Instance.
1517 If not specified, then it is a non-VPC DB instance.
1518 -engine The name of the database engine to be used for this
1520 instance.
1521 Default is that of source.
1522 Valid values: MySQL | oracle-se1 | oracle-se | oracle-ee |
1523 sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web
1524 -iops The amount of Provisioned IOPS initially allocated.
1526 Must be an integer greater than 1000
1527 -license_model License model information for this DB Instance.
1529 Valid values: license-included |
1530 bring-your-own-license |
1531 general-public-license
1532 -multi_az Specifies if the DB Instance is a Multi-AZ deployment.
1534 You cannot set the -availability_zone argument if the
1535 -multi_az argument is set to true.
1536 -option_group_name Indicates that the DB Instance should be associated
1538 with the specified option group.
1539 -port The port number on which the database accepts
1541 connections.
1542 MySQL:
1544 * Default: 3306, Valid values: 1150-65535
1545 Oracle:
1546 * Default: 1521, Valid values: 1150-65535
1547 Oracle:
1548 * Default: 1433, Valid values: 1150-65535 except
1549 1434 and 3389.
1550 -publicly_accessible Specifies the accessibility options for the DB instance. A
1552 value of true specifies an Internet-facing instance with a
1553 publicly resolvable DNS name, which resolves to a public IP
1554 address. A value of false specifies an internal instance with
1555 a DNS name that resolves to a private IP address.
1556 Default: The default behavior varies depending on whether a
1558 VPC has been requested or not. The following list shows the
1559 default behavior in each case.
1560 * DefaultVPC:true
1561 * VPC:false
1562 If no DB subnet group has been specified as part of the
1564 request and the -publicly_accessible value has not been set,
1565 the DB instance will be publicly accessible. If a specific DB
1566 subnet group has been specified as part of the request and
1567 the PubliclyAccessible value has not been set, the DB
1568 instance will be private.
1569 -tags hashref or arrayref of hashrefs containing Key/Value pairs
1571 $db_instance = $ec2->restore_db_instance_to_point_in_time(%args)
1573 Restores a DB instance to an arbitrary point-in-time. Users can restore
1574 to any point in time before the latestRestorableTime for up to
1575 backupRetentionPeriod days. The target database is created from the
1576 source database with the same configuration as the original database
1577 except that the DB instance is created with the default DB security
1578 group.
1579 Required arguments:
1581 -source_db_instance_identifier The identifier of the source DB instance from which to restore.
1583 Constraints: Must be the identifier of an existing DB Instance
1584 -target_db_instance_identifier The name of the new database instance to be created.
1586 Constraints:
1587 * Must contain from 1 to 63 alphanumeric characters or hyphens
1588 * First character must be a letter
1589 * Cannot end with a hyphen or contain two consecutive hyphens
1590 Optional arguments:
1592 -auto_minor_version_upgrade Indicates that minor engine upgrades will be applied
1594 automatically to the DB Instance during the maintenance
1595 window. (Boolean). Default: true
1596 -availability_zone The EC2 Availability Zone that the database instance will
1598 be created in.
1599 Default: A random, system-chosen Availability Zone in the
1600 endpoint's region.
1601 Constraint: Cannot specify if -multi_az is true
1602 -db_instance_class The compute and memory capacity of the DB Instance.
1604 db.t1.micro | db.m1.small | db.m1.medium | db.m1.large |
1605 db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge
1606 -db_name The database name for the restored DB instance.
1608 NOTE: Does not apply to MySQL engine.
1609 -db_subnet_group_name A DB Subnet Group to associate with this DB Instance.
1611 If not specified, then it is a non-VPC DB instance.
1612 -engine The name of the database engine to be used for this
1614 instance.
1615 Default is that of source.
1616 Valid values: MySQL | oracle-se1 | oracle-se | oracle-ee |
1617 sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web
1618 -iops The amount of Provisioned IOPS initially allocated.
1620 Must be an integer greater than 1000
1621 -license_model License model information for this DB Instance.
1623 Valid values: license-included |
1624 bring-your-own-license |
1625 general-public-license
1626 -multi_az Specifies if the DB Instance is a Multi-AZ deployment.
1628 You cannot set the -availability_zone argument if the
1629 -multi_az argument is set to true.
1630 -option_group_name Indicates that the DB Instance should be associated
1632 with the specified option group.
1633 -port The port number on which the database accepts
1635 connections.
1636 MySQL:
1638 * Default: 3306, Valid values: 1150-65535
1639 Oracle:
1640 * Default: 1521, Valid values: 1150-65535
1641 Oracle:
1642 * Default: 1433, Valid values: 1150-65535 except
1643 1434 and 3389.
1644 -publicly_accessible Specifies the accessibility options for the DB instance. A
1646 value of true specifies an Internet-facing instance with a
1647 publicly resolvable DNS name, which resolves to a public IP
1648 address. A value of false specifies an internal instance with
1649 a DNS name that resolves to a private IP address.
1650 Default: The default behavior varies depending on whether a
1652 VPC has been requested or not. The following list shows the
1653 default behavior in each case.
1654 * DefaultVPC:true
1655 * VPC:false
1656 If no DB subnet group has been specified as part of the
1658 request and the -publicly_accessible value has not been set,
1659 the DB instance will be publicly accessible. If a specific DB
1660 subnet group has been specified as part of the request and
1661 the PubliclyAccessible value has not been set, the DB
1662 instance will be private.
1663 -restore_time The date and time to restore from.
1665 Valid Values: Value must be a UTC time
1666 Constraints:
1667 * Must be prior the latest restorable time for the DB
1668 instance
1669 * Cannot be specified if -use_latest_restorable_time
1670 parameter is true
1671 Example: 2009-09-07T23:45:00Z
1672 -tags hashref or arrayref of hashrefs containing Key/Value pairs
1674 -use_latest_restorable_time Specifies if the DB instance is restored from the latest
1676 backup time.
1677 Boolean, default is false.
1678 Constraints: Cannot be specified if -restore_time parameter
1679 is provided.
1680 $sg = $ec2->revoke_db_security_group_ingress(%args)
1682 Revokes ingress from a DBSecurityGroup for previously authorized IP
1683 ranges or EC2 or VPC Security Groups.
1684 Required arguments:
1686 -db_security_group_name The name of the DB Security Group to revoke authorization from.
1688 Optional arguments:
1690 -cidrip The IP range to revoke. Must be a valid CIDR range.
1692 Security group parameters cannot be specified if -cidrip is
1693 specified.
1694 -ec2_security_group_id ID of the EC2 Security Group to revoke access from.
1696 For VPC DB security groups, this must be provided.
1697 -ec2_security_group_name Name of the EC2 Security Group to revoke access from.
1699 -ec2_security_group_owner_id AWS Account Number of the owner of the EC2 Security Group
1701 specified in the -ec2_security_group_name parameter.
1702 Returns a VM::EC2::DB::SecurityGroup object.
1704
1706 Lance Kinley <lkinley@loyaltymethods.com<gt>.
1707 Copyright (c) 2013 Loyalty Methods, Inc.
1709 This package and its accompanying libraries is free software; you can
1711 redistribute it and/or modify it under the terms of the GPL (either
1712 version 1, or at your option, any later version) or the Artistic
1713 License 2.0. Refer to LICENSE for the full license text. In addition,
1714 please see DISCLAIMER.txt for disclaimers of warranty.
1715perl v5.30.0 V2M0:1:9E-C027:-:2R6EST::relational_database_service(3)