Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.
rds_restore_db_instance_from_s3(DBName, DBInstanceIdentifier,
AllocatedStorage, DBInstanceClass, Engine, MasterUsername,
MasterUserPassword, DBSecurityGroups, VpcSecurityGroupIds,
AvailabilityZone, DBSubnetGroupName, PreferredMaintenanceWindow,
DBParameterGroupName, BackupRetentionPeriod, PreferredBackupWindow,
Port, MultiAZ, EngineVersion, AutoMinorVersionUpgrade, LicenseModel,
Iops, OptionGroupName, PubliclyAccessible, Tags, StorageType,
StorageEncrypted, KmsKeyId, CopyTagsToSnapshot, MonitoringInterval,
MonitoringRoleArn, EnableIAMDatabaseAuthentication, SourceEngine,
SourceEngineVersion, S3BucketName, S3Prefix, S3IngestionRoleArn,
EnablePerformanceInsights, PerformanceInsightsKMSKeyId,
PerformanceInsightsRetentionPeriod, EnableCloudwatchLogsExports,
ProcessorFeatures, UseDefaultProcessorFeatures, DeletionProtection)The name of the database to create when the DB instance is created.
Follow the naming rules specified in CreateDBInstance.
[required] The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
The amount of storage (in gigabytes) to allocate initially for the DB
instance. Follow the allocation rules specified in CreateDBInstance.
Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth.
[required] 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.
Importing from Amazon S3 is not supported on the db.t2.micro DB instance class.
[required] The name of the database engine to be used for this instance.
Valid Values: mysql
The name for the master user.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
A list of VPC security groups to associate with this DB instance.
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.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter can't be specified if the
DB instance is a Multi-AZ deployment. The specified Availability Zone
must be in the same AWS Region as the current endpoint.
A DB subnet group to associate with this DB instance.
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.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default parameter group for the specified engine is used.
The number of days for which automated backups are retained. Setting
this parameter to a positive number enables backups. For more
information, see CreateDBInstance.
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.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The port number on which the database accepts connections.
Type: Integer
Valid Values: 1150-65535
Default: 3306
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.
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.
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.
The license model for this DB instance. Use general-public-license.
The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid Iops values, see see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.
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.
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 is not publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.
A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Specifies the storage type to be associated with the DB instance.
Valid values: standard \| gp2 \| io1
If you specify io1, you must also include a value for the Iops
parameter.
Default: io1 if the Iops parameter is specified; otherwise gp2
A value that indicates whether the new DB instance is encrypted or not.
The AWS KMS key identifier for an encrypted DB instance.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted parameter is enabled, and you do not specify a
value for the KmsKeyId parameter, then Amazon RDS will use your
default encryption key. AWS KMS creates the default encryption key for
your AWS account. Your AWS account has a different default encryption
key for each AWS Region.
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.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, then you must also set
MonitoringInterval to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Default: 0
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.
If MonitoringInterval is set to a value other than 0, then you must
supply a MonitoringRoleArn value.
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
[required] The name of the engine of your source database.
Valid Values: mysql
[required] The engine version of your source database.
Valid Values: 5.6
[required] The name of your Amazon S3 bucket that contains your database backup file.
The prefix of your Amazon S3 bucket.
[required] An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.
A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
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.
If you do not specify a value for PerformanceInsightsKMSKeyId, then
Amazon RDS uses your default encryption key. AWS KMS creates the default
encryption key for your AWS account. Your AWS account has a different
default encryption key for each AWS Region.
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
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.
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
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.
svc$restore_db_instance_from_s3(
DBName = "string",
DBInstanceIdentifier = "string",
AllocatedStorage = 123,
DBInstanceClass = "string",
Engine = "string",
MasterUsername = "string",
MasterUserPassword = "string",
DBSecurityGroups = list(
"string"
),
VpcSecurityGroupIds = list(
"string"
),
AvailabilityZone = "string",
DBSubnetGroupName = "string",
PreferredMaintenanceWindow = "string",
DBParameterGroupName = "string",
BackupRetentionPeriod = 123,
PreferredBackupWindow = "string",
Port = 123,
MultiAZ = TRUE|FALSE,
EngineVersion = "string",
AutoMinorVersionUpgrade = TRUE|FALSE,
LicenseModel = "string",
Iops = 123,
OptionGroupName = "string",
PubliclyAccessible = TRUE|FALSE,
Tags = list(
list(
Key = "string",
Value = "string"
)
),
StorageType = "string",
StorageEncrypted = TRUE|FALSE,
KmsKeyId = "string",
CopyTagsToSnapshot = TRUE|FALSE,
MonitoringInterval = 123,
MonitoringRoleArn = "string",
EnableIAMDatabaseAuthentication = TRUE|FALSE,
SourceEngine = "string",
SourceEngineVersion = "string",
S3BucketName = "string",
S3Prefix = "string",
S3IngestionRoleArn = "string",
EnablePerformanceInsights = TRUE|FALSE,
PerformanceInsightsKMSKeyId = "string",
PerformanceInsightsRetentionPeriod = 123,
EnableCloudwatchLogsExports = list(
"string"
),
ProcessorFeatures = list(
list(
Name = "string",
Value = "string"
)
),
UseDefaultProcessorFeatures = TRUE|FALSE,
DeletionProtection = TRUE|FALSE
)