rds_restore_db_instance_from_s3 function

Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files

Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files

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.

See https://www.paws-r-sdk.com/docs/rds_restore_db_instance_from_s3/ for full documentation.

rds_restore_db_instance_from_s3(
  DBName = NULL,
  DBInstanceIdentifier,
  AllocatedStorage = NULL,
  DBInstanceClass,
  Engine,
  MasterUsername = NULL,
  MasterUserPassword = NULL,
  DBSecurityGroups = NULL,
  VpcSecurityGroupIds = NULL,
  AvailabilityZone = NULL,
  DBSubnetGroupName = NULL,
  PreferredMaintenanceWindow = NULL,
  DBParameterGroupName = NULL,
  BackupRetentionPeriod = NULL,
  PreferredBackupWindow = NULL,
  Port = NULL,
  MultiAZ = NULL,
  EngineVersion = NULL,
  AutoMinorVersionUpgrade = NULL,
  LicenseModel = NULL,
  Iops = NULL,
  OptionGroupName = NULL,
  PubliclyAccessible = NULL,
  Tags = NULL,
  StorageType = NULL,
  StorageEncrypted = NULL,
  KmsKeyId = NULL,
  CopyTagsToSnapshot = NULL,
  MonitoringInterval = NULL,
  MonitoringRoleArn = NULL,
  EnableIAMDatabaseAuthentication = NULL,
  SourceEngine,
  SourceEngineVersion,
  S3BucketName,
  S3Prefix = NULL,
  S3IngestionRoleArn,
  DatabaseInsightsMode = NULL,
  EnablePerformanceInsights = NULL,
  PerformanceInsightsKMSKeyId = NULL,
  PerformanceInsightsRetentionPeriod = NULL,
  EnableCloudwatchLogsExports = NULL,
  ProcessorFeatures = NULL,
  UseDefaultProcessorFeatures = NULL,
  DeletionProtection = NULL,
  MaxAllocatedStorage = NULL,
  NetworkType = NULL,
  StorageThroughput = NULL,
  ManageMasterUserPassword = NULL,
  MasterUserSecretKmsKeyId = NULL,
  DedicatedLogVolume = NULL,
  CACertificateIdentifier = NULL,
  EngineLifecycleSupport = NULL
)

Arguments

  • DBName: The name of the database to create when the DB instance is created. Follow the naming rules specified in create_db_instance.

  • DBInstanceIdentifier: [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

  • AllocatedStorage: The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in create_db_instance.

    This setting isn't valid for RDS for SQL Server.

    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.

  • DBInstanceClass: [required] 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.

  • Engine: [required] The name of the database engine to be used for this instance.

    Valid Values: mysql

  • MasterUsername: 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.

  • MasterUserPassword: 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.

  • DBSecurityGroups: A list of DB security groups to associate with this DB instance.

    Default: The default DB security group for the database engine.

  • VpcSecurityGroupIds: A list of VPC security groups to associate with this DB instance.

  • AvailabilityZone: 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.

  • DBSubnetGroupName: A DB subnet group to associate with this DB instance.

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    Example: mydbsubnetgroup

  • PreferredMaintenanceWindow: 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.

  • DBParameterGroupName: The name of the DB parameter group to associate with this DB instance.

    If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.

  • BackupRetentionPeriod: The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see create_db_instance.

  • PreferredBackupWindow: 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.

  • Port: The port number on which the database accepts connections.

    Type: Integer

    Valid Values: 1150-65535

    Default: 3306

  • MultiAZ: 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.

  • EngineVersion: The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see create_db_instance, or call describe_db_engine_versions.

  • AutoMinorVersionUpgrade: 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.

  • LicenseModel: The license model for this DB instance. Use general-public-license.

  • Iops: 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.

  • OptionGroupName: 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.

  • PubliclyAccessible: 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 create_db_instance.

  • Tags: A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources

    in the Amazon RDS User Guide.

  • StorageType: Specifies the storage type to be associated with the DB instance.

    Valid Values: gp2 | gp3 | io1 | io2 | standard

    If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.

    Default: io1 if the Iops parameter is specified; otherwise gp2

  • StorageEncrypted: Specifies whether the new DB instance is encrypted or not.

  • KmsKeyId: 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 the KmsKeyId 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.

  • CopyTagsToSnapshot: Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

  • MonitoringInterval: 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

  • MonitoringRoleArn: 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.

  • EnableIAMDatabaseAuthentication: 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.

  • SourceEngine: [required] The name of the engine of your source database.

    Valid Values: mysql

  • SourceEngineVersion: [required] 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

  • S3BucketName: [required] The name of your Amazon S3 bucket that contains your database backup file.

  • S3Prefix: The prefix of your Amazon S3 bucket.

  • S3IngestionRoleArn: [required] 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.

  • DatabaseInsightsMode: Specifies the mode of Database Insights to enable for the DB instance.

    Aurora DB instances inherit this value from the DB cluster, so you can't change this value.

  • EnablePerformanceInsights: Specifies whether to enable Performance Insights for the DB instance.

    For more information, see Using Amazon Performance Insights

    in the Amazon RDS User Guide.

  • PerformanceInsightsKMSKeyId: 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.

  • PerformanceInsightsRetentionPeriod: 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.

  • EnableCloudwatchLogsExports: 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.

  • ProcessorFeatures: The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

  • UseDefaultProcessorFeatures: Specifies whether the DB instance class of the DB instance uses its default processor features.

  • DeletionProtection: 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.

  • MaxAllocatedStorage: 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.

  • NetworkType: The network type of the DB instance.

    Valid Values:

    • IPV4
    • DUAL

    The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup 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.

  • StorageThroughput: Specifies the storage throughput value for the DB instance.

    This setting doesn't apply to RDS Custom or Amazon Aurora.

  • ManageMasterUserPassword: 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.

  • MasterUserSecretKmsKeyId: 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 the aws/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 the aws/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.

  • DedicatedLogVolume: Specifies whether to enable a dedicated log volume (DLV) for the DB instance.

  • CACertificateIdentifier: 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.

  • EngineLifecycleSupport: 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 to open-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

paws.database packageRead PDF manual
  • Maintainer: Dyfan Jones
  • License: Apache License (>= 2.0)
  • Last published: 2025-03-14

Useful links