Restore DB Instance From S3
GET {{aws_rds_base_url}}/?AllocatedStorage&AutoMinorVersionUpgrade&AvailabilityZone&BackupRetentionPeriod&CopyTagsToSnapshot&DBInstanceClass&DBInstanceIdentifier&DBName&DBParameterGroupName&DBSecurityGroups.DBSecurityGroupName.N&DBSubnetGroupName&DeletionProtection&EnableCloudwatchLogsExports.member.N&EnableIAMDatabaseAuthentication&EnablePerformanceInsights&Engine&EngineVersion&Iops&KmsKeyId&LicenseModel&MasterUsername&MasterUserPassword&MonitoringInterval&MonitoringRoleArn&MultiAZ&OptionGroupName&PerformanceInsightsKMSKeyId&PerformanceInsightsRetentionPeriod&Port&PreferredBackupWindow&PreferredMaintenanceWindow&ProcessorFeatures.ProcessorFeature.N&PubliclyAccessible&S3BucketName&S3IngestionRoleArn&S3Prefix&SourceEngine&SourceEngineVersion&StorageEncrypted&StorageType&Tags.Tag.N&UseDefaultProcessorFeatures&VpcSecurityGroupIds.VpcSecurityGroupId.N&Action=RestoreDBInstanceFromS3&Version=2014-10-31
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
AllocatedStorage | null | The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance. | |
AutoMinorVersionUpgrade | null | A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically. | |
AvailabilityZone | null | The Availability Zone that the DB instance is created in. For information about AWS Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide. | |
BackupRetentionPeriod | null | The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance. | |
CopyTagsToSnapshot | null | A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. | |
DBInstanceClass | null | The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. | |
DBInstanceIdentifier | null | The DB instance identifier. This parameter is stored as a lowercase string. | |
DBName | null | The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance. | |
DBParameterGroupName | null | The name of the DB parameter group to associate with this DB instance. | |
DBSecurityGroups.DBSecurityGroupName.N | null | A list of DB security groups to associate with this DB instance. | |
DBSubnetGroupName | null | A DB subnet group to associate with this DB instance. | |
DeletionProtection | null | A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance. | |
EnableCloudwatchLogsExports.member.N | null | The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. | |
EnableIAMDatabaseAuthentication | null | A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance. | |
EnablePerformanceInsights | null | A value that indicates whether to enable Performance Insights for the DB instance. | |
Engine | null | The name of the database engine to be used for this instance. | |
EngineVersion | null | The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions. | |
Iops | null | The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. | |
KmsKeyId | null | The AWS KMS key identifier for an encrypted DB instance. | |
LicenseModel | null | The license model for this DB instance. Use general-public-license. | |
MasterUsername | null | The name for the master user. | |
MasterUserPassword | null | The password for the master user. The password can include any printable ASCII character except /, , or @. | |
MonitoringInterval | null | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. | |
MonitoringRoleArn | null | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide. | |
MultiAZ | null | A value that indicates whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter. | |
OptionGroupName | null | The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used. | |
PerformanceInsightsKMSKeyId | null | The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. | |
PerformanceInsightsRetentionPeriod | null | The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years). | |
Port | null | The port number on which the database accepts connections. | |
PreferredBackupWindow | null | The time range each day during which automated backups are created if automated backups are enabled. For more information, see The Backup Window in the Amazon RDS User Guide. | |
PreferredMaintenanceWindow | null | The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide. | |
ProcessorFeatures.ProcessorFeature.N | null | The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. | |
PubliclyAccessible | null | A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance. | |
S3BucketName | null | The name of your Amazon S3 bucket that contains your database backup file. | |
S3IngestionRoleArn | null | An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket. | |
S3Prefix | null | The prefix of your Amazon S3 bucket. | |
SourceEngine | null | The name of the engine of your source database. | |
SourceEngineVersion | null | The engine version of your source database. | |
StorageEncrypted | null | A value that indicates whether the new DB instance is encrypted or not. | |
StorageType | null | Specifies the storage type to be associated with the DB instance. | |
Tags.Tag.N | null | A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. | |
UseDefaultProcessorFeatures | null | A value that indicates whether the DB instance class of the DB instance uses its default processor features. | |
VpcSecurityGroupIds.VpcSecurityGroupId.N | null | A list of VPC security groups to associate with this DB instance. | |
Action | string | ||
Version | string |