/AWS1/CL_RDS=>RESTOREDBINSTANCEFROMS3()
¶
About RestoreDBInstanceFromS3¶
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.
This operation doesn't apply to RDS Custom.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_DBINSTANCEIDENTIFIER
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
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
IV_DBINSTANCECLASS
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
The compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services 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 isn't supported on the db.t2.micro DB instance class.
IV_ENGINE
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
The name of the database engine to be used for this instance.
Valid Values:
mysql
IV_SOURCEENGINE
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
The name of the engine of your source database.
Valid Values:
mysql
IV_SOURCEENGINEVERSION
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
The version of the database that the backup files were created from.
MySQL versions 5.6 and 5.7 are supported.
Example:
5.6.40
IV_S3BUCKETNAME
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
The name of your Amazon S3 bucket that contains your database backup file.
IV_S3INGESTIONROLEARN
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
An Amazon Web Services Identity and Access Management (IAM) role with a trust policy and a permissions policy that allows Amazon RDS to access your Amazon S3 bucket. For information about this role, see Creating an IAM role manually in the Amazon RDS User Guide.
Optional arguments:¶
IV_DBNAME
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
The name of the database to create when the DB instance is created. Follow the naming rules specified in
CreateDBInstance
.
IV_ALLOCATEDSTORAGE
TYPE /AWS1/RDSINTEGEROPTIONAL
/AWS1/RDSINTEGEROPTIONAL
¶
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in
CreateDBInstance
.Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
IV_MASTERUSERNAME
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
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.
IV_MASTERUSERPASSWORD
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
The password for the master user.
Constraints:
Can't be specified if
ManageMasterUserPassword
is turned on.Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.
Length Constraints:
RDS for Db2 - Must contain from 8 to 128 characters.
RDS for MariaDB - Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
RDS for MySQL - Must contain from 8 to 41 characters.
RDS for Oracle - Must contain from 8 to 30 characters.
RDS for PostgreSQL - Must contain from 8 to 128 characters.
IT_DBSECURITYGROUPS
TYPE /AWS1/CL_RDSDBSECGRPNAMELIST_W=>TT_DBSECURITYGROUPNAMELIST
TT_DBSECURITYGROUPNAMELIST
¶
A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
IT_VPCSECURITYGROUPIDS
TYPE /AWS1/CL_RDSVPCSECGRPIDLIST_W=>TT_VPCSECURITYGROUPIDLIST
TT_VPCSECURITYGROUPIDLIST
¶
A list of VPC security groups to associate with this DB instance.
IV_AVAILABILITYZONE
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
The Availability Zone that the DB instance is created in. For information about Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services Region as the current endpoint.
IV_DBSUBNETGROUPNAME
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
A DB subnet group to associate with this DB instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example:
mydbsubnetgroup
IV_PREFERREDMAINTENANCEWIN00
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
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.
IV_DBPARAMETERGROUPNAME
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for
DBParameterGroupName
, then the defaultDBParameterGroup
for the specified DB engine is used.
IV_BACKUPRETENTIONPERIOD
TYPE /AWS1/RDSINTEGEROPTIONAL
/AWS1/RDSINTEGEROPTIONAL
¶
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see
CreateDBInstance
.
IV_PREFERREDBACKUPWINDOW
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
The time range each day during which automated backups are created if automated backups are enabled. For more information, see 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.
IV_PORT
TYPE /AWS1/RDSINTEGEROPTIONAL
/AWS1/RDSINTEGEROPTIONAL
¶
The port number on which the database accepts connections.
Type: Integer
Valid Values:
1150
-65535
Default:
3306
IV_MULTIAZ
TYPE /AWS1/RDSBOOLEANOPTIONAL
/AWS1/RDSBOOLEANOPTIONAL
¶
Specifies 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.
IV_ENGINEVERSION
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
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 callDescribeDBEngineVersions
.
IV_AUTOMINORVERSIONUPGRADE
TYPE /AWS1/RDSBOOLEANOPTIONAL
/AWS1/RDSBOOLEANOPTIONAL
¶
Specifies whether to automatically apply minor engine upgrades
to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.
IV_LICENSEMODEL
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
The license model for this DB instance. Use
general-public-license
.
IV_IOPS
TYPE /AWS1/RDSINTEGEROPTIONAL
/AWS1/RDSINTEGEROPTIONAL
¶
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 in the Amazon RDS User Guide.
IV_OPTIONGROUPNAME
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
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.
IV_PUBLICLYACCESSIBLE
TYPE /AWS1/RDSBOOLEANOPTIONAL
/AWS1/RDSBOOLEANOPTIONAL
¶
Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
IT_TAGS
TYPE /AWS1/CL_RDSTAG=>TT_TAGLIST
TT_TAGLIST
¶
A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
IV_STORAGETYPE
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
Specifies the storage type to be associated with the DB instance.
Valid Values:
gp2 | gp3 | io1 | io2 | standard
If you specify
io1
,io2
, orgp3
, you must also include a value for theIops
parameter.Default:
io1
if theIops
parameter is specified; otherwisegp2
IV_STORAGEENCRYPTED
TYPE /AWS1/RDSBOOLEANOPTIONAL
/AWS1/RDSBOOLEANOPTIONAL
¶
Specifies whether the new DB instance is encrypted or not.
IV_KMSKEYID
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
The Amazon Web Services KMS key identifier for an encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the
StorageEncrypted
parameter is enabled, and you do not specify a value for theKmsKeyId
parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
IV_COPYTAGSTOSNAPSHOT
TYPE /AWS1/RDSBOOLEANOPTIONAL
/AWS1/RDSBOOLEANOPTIONAL
¶
Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
IV_MONITORINGINTERVAL
TYPE /AWS1/RDSINTEGEROPTIONAL
/AWS1/RDSINTEGEROPTIONAL
¶
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 setMonitoringInterval
to a value other than 0.Valid Values: 0, 1, 5, 10, 15, 30, 60
Default:
0
IV_MONITORINGROLEARN
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
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 aMonitoringRoleArn
value.
IV_ENBIAMDATABASEAUTHNTCTN
TYPE /AWS1/RDSBOOLEANOPTIONAL
/AWS1/RDSBOOLEANOPTIONAL
¶
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
IV_S3PREFIX
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
The prefix of your Amazon S3 bucket.
IV_ENABLEPERFORMANCEINSIGHTS
TYPE /AWS1/RDSBOOLEANOPTIONAL
/AWS1/RDSBOOLEANOPTIONAL
¶
Specifies whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
IV_PERFORMANCEINSIGHTSKMSK00
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
IV_PERFORMANCEINSIGHTSRETPER
TYPE /AWS1/RDSINTEGEROPTIONAL
/AWS1/RDSINTEGEROPTIONAL
¶
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
IT_ENABLECLOUDWATCHLOGSEXP
TYPE /AWS1/CL_RDSLOGTYPELIST_W=>TT_LOGTYPELIST
TT_LOGTYPELIST
¶
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.
IT_PROCESSORFEATURES
TYPE /AWS1/CL_RDSPROCESSORFEATURE=>TT_PROCESSORFEATURELIST
TT_PROCESSORFEATURELIST
¶
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
IV_USEDEFPROCESSORFEATURES
TYPE /AWS1/RDSBOOLEANOPTIONAL
/AWS1/RDSBOOLEANOPTIONAL
¶
Specifies whether the DB instance class of the DB instance uses its default processor features.
IV_DELETIONPROTECTION
TYPE /AWS1/RDSBOOLEANOPTIONAL
/AWS1/RDSBOOLEANOPTIONAL
¶
Specifies whether to enable deletion protection for the DB instance. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
IV_MAXALLOCATEDSTORAGE
TYPE /AWS1/RDSINTEGEROPTIONAL
/AWS1/RDSINTEGEROPTIONAL
¶
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
IV_NETWORKTYPE
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
The network type of the DB instance.
Valid Values:
IPV4
DUAL
The network type is determined by the
DBSubnetGroup
specified for the DB instance. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL
).For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
IV_STORAGETHROUGHPUT
TYPE /AWS1/RDSINTEGEROPTIONAL
/AWS1/RDSINTEGEROPTIONAL
¶
Specifies the storage throughput value for the DB instance.
This setting doesn't apply to RDS Custom or Amazon Aurora.
IV_MANAGEMASTERUSERPASSWORD
TYPE /AWS1/RDSBOOLEANOPTIONAL
/AWS1/RDSBOOLEANOPTIONAL
¶
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if
MasterUserPassword
is specified.
IV_MASTERUSERSECRETKMSKEYID
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify
MasterUserSecretKmsKeyId
, then theaws/secretsmanager
KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use theaws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS key.There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
IV_DEDICATEDLOGVOLUME
TYPE /AWS1/RDSBOOLEANOPTIONAL
/AWS1/RDSBOOLEANOPTIONAL
¶
Specifies whether to enable a dedicated log volume (DLV) for the DB instance.
IV_CACERTIFICATEIDENTIFIER
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
IV_ENGINELIFECYCLESUPPORT
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
The life cycle type for this DB instance.
By default, this value is set to
open-source-rds-extended-support
, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value toopen-source-rds-extended-support-disabled
. In this case,
RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values:
open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default:
open-source-rds-extended-support