Description

The Restore RDS Instance action can be used to restore an RDS instance from an RDS snapshot. Later, it can (optionally) be deleted.

For example, at 8am, a small (db.m1.small) RDS instance can be restored from the latest snapshot of a production RDS instance for development purposes, then 8 hours later, it can be deleted.

Settings

Please see Common Action Settings for a description of settings common to all action types.

Snapshot Identification Method

Indicates how the source snapshot will be selected. Valid values are:

  • By Snapshot ID - Specify a snapshot ID to restore from
  • RDS Instance Newest Snapshot - Uses the newest snapshot from the specified RDS instance

Source RDS Snapshot ID

Indicates the RDS snapshot ID from which the new RDS instance will be restored. Required if Snapshot Identification Method is set to "By Snapshot ID". This snapshot must exist in the region specified.

Source RDS Instance ID

Indicates the RDS instance ID from which the newest RDS snapshot will be used to restore the new RDS instance. Required if Snapshot Identification Method is set to "RDS Instance Newest Snapshot". This instance must exist in the region specified.

New RDS Instance ID

Indicates the instance identifier of the new RDS instance. Macros can be used in the instance ID to include run-time data. See below.

Instance Class

Specify the instance class (machine size) that the new RDS instance will be created as.

Multi-AZ

Indicates whether the new RDS instance will be multi-AZ.

Availability Zone

Indicates the desired availability zone in which the new RDS instance will be created. This value cannot be specified if Multi-AZ is set to 'True'.

Security Group

Optional. By default, the restored RDS instance will use the 'default' security group. Specify an alternate security group to have it assigned to the new RDS instance.

DB Subnet Group Name

Optional. If the new RDS instance is to reside inside a VPC, specify the DB Subnet Group Name to use for the new instance.

DB Parameter Group Name

Optional. Specify an alternate parameter group to use for the new RDS instance.

Option Group Name

Optional. Specify an alternate option group to use for the new RDS instance.

Storage Type

Optional Indicate whether the new RDS instance should have a different storage type. Options include:

  • No Change
  • General Purpose (SSD)
  • Provisioned IOPS (SSD)
  • Magnetic

Change IOPS

Indicate whether the new RDS instance should have a different IOPS value. Options include:

  • No Change
  • Remove IOPS
  • Set New IOPS

New IOPS

If Change IOPS is "Set New IOPS", then specify the IOPS value.for the new RDS instance.

Change Publicly Accessible

By default, a restored RDS instance is publicly accessible if the snapshot was created from a publicly accessible instance. Use this field to explicitly set the new RDS instance as publicly accessible or not.

Resource Tags

Optional. Extra resource tags can be assigned to the new instance. Click "Add Tag" to add a tag and fill the tag data. Any number of tags can be set, although Amazon RDS has a limit of 10 (including the Name tag). Macros can be used in the tag values to include run-time data. See below.

Delete the Instance

Indicate whether the new RDS instance should be automatically deleted later. The running time of the instance must also be specified if this is enabled.

Running Duration

Indicate the length of time the RDS instance should remain running before it is deleted. This value is only required if "Delete the Instance" is enabled.

Create a Final Snapshot

Indicates whether a final snapshot should be created of the new RDS instance when it is deleted. This value is only available if "Delete the Instance" is enabled.

Final Snapshot ID

Indicates the snapshot ID of the final snapshot when the instance is deleted. This value is only required if "Create a Final Snapshot" is enabled. Macros can be used in the snapshot ID to include run-time data. See below.

Macros

The following macros can be used to include some run-time information.

$(DATE)

Date of snapshot in year-month-day format

$(TIME)

Time of snapshot in 24-hour format

Macros are case-sensitive. For example, $(Time) is not valid. $(TIME) must be used.

Amazon Commands Used

The following Amazon AWS commands are used. The access key should have permission to execute all of them.

  • ec2:DescribeSecurityGroups
  • rds:DeleteDBInstance
  • rds:DescribeDBInstances
  • rds:DescribeDBSnapshots
  • rds:ModifyDBInstance
  • rds:RestoreDBInstanceFromDBSnapshot
Did this answer your question?