restoreDBInstanceFromS3 method

Future<RestoreDBInstanceFromS3Result> restoreDBInstanceFromS3({ required String dBInstanceClass, required String dBInstanceIdentifier, required String engine, required String s3BucketName, required String s3IngestionRoleArn, required String sourceEngine, required String sourceEngineVersion, int? allocatedStorage, bool? autoMinorVersionUpgrade, String? availabilityZone, int? backupRetentionPeriod, bool? copyTagsToSnapshot, String? dBName, String? dBParameterGroupName, List<String>? dBSecurityGroups, String? dBSubnetGroupName, bool? deletionProtection, List<String>? enableCloudwatchLogsExports, bool? enableIAMDatabaseAuthentication, bool? enablePerformanceInsights, String? engineVersion, int? iops, String? kmsKeyId, String? licenseModel, String? masterUserPassword, String? masterUsername, int? maxAllocatedStorage, int? monitoringInterval, String? monitoringRoleArn, bool? multiAZ, String? optionGroupName, String? performanceInsightsKMSKeyId, int? performanceInsightsRetentionPeriod, int? port, String? preferredBackupWindow, String? preferredMaintenanceWindow, List<ProcessorFeature>? processorFeatures, bool? publiclyAccessible, String? s3Prefix, bool? storageEncrypted, String? storageType, List<Tag>? tags, bool? useDefaultProcessorFeatures, List<String>? vpcSecurityGroupIds, })

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.

May throw DBInstanceAlreadyExistsFault. May throw InsufficientDBInstanceCapacityFault. May throw DBParameterGroupNotFoundFault. May throw DBSecurityGroupNotFoundFault. May throw InstanceQuotaExceededFault. May throw StorageQuotaExceededFault. May throw DBSubnetGroupNotFoundFault. May throw DBSubnetGroupDoesNotCoverEnoughAZs. May throw InvalidSubnet. May throw InvalidVPCNetworkStateFault. May throw InvalidS3BucketFault. May throw ProvisionedIopsNotAvailableInAZFault. May throw OptionGroupNotFoundFault. May throw StorageTypeNotSupportedFault. May throw AuthorizationNotFoundFault. May throw KMSKeyNotAccessibleFault. May throw BackupPolicyNotFoundFault.

Parameter dBInstanceClass : 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 isn't supported on the db.t2.micro DB instance class.

Parameter dBInstanceIdentifier : 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

Parameter engine : The name of the database engine to be used for this instance.

Valid Values: mysql

Parameter s3BucketName : The name of your Amazon S3 bucket that contains your database backup file.

Parameter s3IngestionRoleArn : An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.

Parameter sourceEngine : The name of the engine of your source database.

Valid Values: mysql

Parameter sourceEngineVersion : 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

Parameter allocatedStorage : The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.

Parameter autoMinorVersionUpgrade : 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.

Parameter availabilityZone : 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.

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

Parameter copyTagsToSnapshot : 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.

Parameter dBName : The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.

Parameter 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.

Parameter dBSecurityGroups : A list of DB security groups to associate with this DB instance.

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

Parameter dBSubnetGroupName : A DB subnet group to associate with this DB instance.

Parameter deletionProtection : 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.

Parameter 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.

Parameter enableIAMDatabaseAuthentication : 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 more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

Parameter enablePerformanceInsights : 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.

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 CreateDBInstance, or call DescribeDBEngineVersions.

Parameter 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 to Improve Performance in the Amazon RDS User Guide.

Parameter kmsKeyId : The AWS KMS key identifier for an encrypted DB instance.

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). To use a CMK in a different AWS 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 CMK. There is a default CMK for your AWS account. Your AWS account has a different default CMK for each AWS Region.

Parameter licenseModel : The license model for this DB instance. Use general-public-license.

Parameter masterUserPassword : The password for the master user. The password can include any printable ASCII character except "/", """, or "@".

Constraints: Must contain from 8 to 41 characters.

Parameter 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.

Parameter maxAllocatedStorage : The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

Parameter 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

Parameter 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.

Parameter multiAZ : 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.

Parameter 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.

Parameter performanceInsightsKMSKeyId : The AWS KMS key identifier for encryption of Performance Insights data.

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default CMK. There is a default CMK for your AWS account. Your AWS account has a different default CMK for each AWS Region.

Parameter performanceInsightsRetentionPeriod : The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

Parameter port : The port number on which the database accepts connections.

Type: Integer

Valid Values: 1150-65535

Default: 3306

Parameter preferredBackupWindow : 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.

Parameter 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.

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

Parameter publiclyAccessible : A value that indicates whether the DB instance is publicly accessible.

When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.

Parameter s3Prefix : The prefix of your Amazon S3 bucket.

Parameter storageEncrypted : A value that indicates whether the new DB instance is encrypted or not.

Parameter storageType : 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

Parameter 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.

Parameter useDefaultProcessorFeatures : A value that indicates whether the DB instance class of the DB instance uses its default processor features.

Parameter vpcSecurityGroupIds : A list of VPC security groups to associate with this DB instance.

Implementation

Future<RestoreDBInstanceFromS3Result> restoreDBInstanceFromS3({
  required String dBInstanceClass,
  required String dBInstanceIdentifier,
  required String engine,
  required String s3BucketName,
  required String s3IngestionRoleArn,
  required String sourceEngine,
  required String sourceEngineVersion,
  int? allocatedStorage,
  bool? autoMinorVersionUpgrade,
  String? availabilityZone,
  int? backupRetentionPeriod,
  bool? copyTagsToSnapshot,
  String? dBName,
  String? dBParameterGroupName,
  List<String>? dBSecurityGroups,
  String? dBSubnetGroupName,
  bool? deletionProtection,
  List<String>? enableCloudwatchLogsExports,
  bool? enableIAMDatabaseAuthentication,
  bool? enablePerformanceInsights,
  String? engineVersion,
  int? iops,
  String? kmsKeyId,
  String? licenseModel,
  String? masterUserPassword,
  String? masterUsername,
  int? maxAllocatedStorage,
  int? monitoringInterval,
  String? monitoringRoleArn,
  bool? multiAZ,
  String? optionGroupName,
  String? performanceInsightsKMSKeyId,
  int? performanceInsightsRetentionPeriod,
  int? port,
  String? preferredBackupWindow,
  String? preferredMaintenanceWindow,
  List<ProcessorFeature>? processorFeatures,
  bool? publiclyAccessible,
  String? s3Prefix,
  bool? storageEncrypted,
  String? storageType,
  List<Tag>? tags,
  bool? useDefaultProcessorFeatures,
  List<String>? vpcSecurityGroupIds,
}) async {
  ArgumentError.checkNotNull(dBInstanceClass, 'dBInstanceClass');
  ArgumentError.checkNotNull(dBInstanceIdentifier, 'dBInstanceIdentifier');
  ArgumentError.checkNotNull(engine, 'engine');
  ArgumentError.checkNotNull(s3BucketName, 's3BucketName');
  ArgumentError.checkNotNull(s3IngestionRoleArn, 's3IngestionRoleArn');
  ArgumentError.checkNotNull(sourceEngine, 'sourceEngine');
  ArgumentError.checkNotNull(sourceEngineVersion, 'sourceEngineVersion');
  final $request = <String, dynamic>{};
  $request['DBInstanceClass'] = dBInstanceClass;
  $request['DBInstanceIdentifier'] = dBInstanceIdentifier;
  $request['Engine'] = engine;
  $request['S3BucketName'] = s3BucketName;
  $request['S3IngestionRoleArn'] = s3IngestionRoleArn;
  $request['SourceEngine'] = sourceEngine;
  $request['SourceEngineVersion'] = sourceEngineVersion;
  allocatedStorage?.also((arg) => $request['AllocatedStorage'] = arg);
  autoMinorVersionUpgrade
      ?.also((arg) => $request['AutoMinorVersionUpgrade'] = arg);
  availabilityZone?.also((arg) => $request['AvailabilityZone'] = arg);
  backupRetentionPeriod
      ?.also((arg) => $request['BackupRetentionPeriod'] = arg);
  copyTagsToSnapshot?.also((arg) => $request['CopyTagsToSnapshot'] = arg);
  dBName?.also((arg) => $request['DBName'] = arg);
  dBParameterGroupName?.also((arg) => $request['DBParameterGroupName'] = arg);
  dBSecurityGroups?.also((arg) => $request['DBSecurityGroups'] = arg);
  dBSubnetGroupName?.also((arg) => $request['DBSubnetGroupName'] = arg);
  deletionProtection?.also((arg) => $request['DeletionProtection'] = arg);
  enableCloudwatchLogsExports
      ?.also((arg) => $request['EnableCloudwatchLogsExports'] = arg);
  enableIAMDatabaseAuthentication
      ?.also((arg) => $request['EnableIAMDatabaseAuthentication'] = arg);
  enablePerformanceInsights
      ?.also((arg) => $request['EnablePerformanceInsights'] = arg);
  engineVersion?.also((arg) => $request['EngineVersion'] = arg);
  iops?.also((arg) => $request['Iops'] = arg);
  kmsKeyId?.also((arg) => $request['KmsKeyId'] = arg);
  licenseModel?.also((arg) => $request['LicenseModel'] = arg);
  masterUserPassword?.also((arg) => $request['MasterUserPassword'] = arg);
  masterUsername?.also((arg) => $request['MasterUsername'] = arg);
  maxAllocatedStorage?.also((arg) => $request['MaxAllocatedStorage'] = arg);
  monitoringInterval?.also((arg) => $request['MonitoringInterval'] = arg);
  monitoringRoleArn?.also((arg) => $request['MonitoringRoleArn'] = arg);
  multiAZ?.also((arg) => $request['MultiAZ'] = arg);
  optionGroupName?.also((arg) => $request['OptionGroupName'] = arg);
  performanceInsightsKMSKeyId
      ?.also((arg) => $request['PerformanceInsightsKMSKeyId'] = arg);
  performanceInsightsRetentionPeriod
      ?.also((arg) => $request['PerformanceInsightsRetentionPeriod'] = arg);
  port?.also((arg) => $request['Port'] = arg);
  preferredBackupWindow
      ?.also((arg) => $request['PreferredBackupWindow'] = arg);
  preferredMaintenanceWindow
      ?.also((arg) => $request['PreferredMaintenanceWindow'] = arg);
  processorFeatures?.also((arg) => $request['ProcessorFeatures'] = arg);
  publiclyAccessible?.also((arg) => $request['PubliclyAccessible'] = arg);
  s3Prefix?.also((arg) => $request['S3Prefix'] = arg);
  storageEncrypted?.also((arg) => $request['StorageEncrypted'] = arg);
  storageType?.also((arg) => $request['StorageType'] = arg);
  tags?.also((arg) => $request['Tags'] = arg);
  useDefaultProcessorFeatures
      ?.also((arg) => $request['UseDefaultProcessorFeatures'] = arg);
  vpcSecurityGroupIds?.also((arg) => $request['VpcSecurityGroupIds'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'RestoreDBInstanceFromS3',
    version: '2014-10-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['RestoreDBInstanceFromS3Message'],
    shapes: shapes,
    resultWrapper: 'RestoreDBInstanceFromS3Result',
  );
  return RestoreDBInstanceFromS3Result.fromXml($result);
}