restoreDBInstanceFromDBSnapshot method

Future<RestoreDBInstanceFromDBSnapshotResult> restoreDBInstanceFromDBSnapshot({
  1. required String dBInstanceIdentifier,
  2. required String dBSnapshotIdentifier,
  3. bool? autoMinorVersionUpgrade,
  4. String? availabilityZone,
  5. bool? copyTagsToSnapshot,
  6. String? dBInstanceClass,
  7. String? dBName,
  8. String? dBParameterGroupName,
  9. String? dBSubnetGroupName,
  10. bool? deletionProtection,
  11. String? domain,
  12. String? domainIAMRoleName,
  13. List<String>? enableCloudwatchLogsExports,
  14. bool? enableCustomerOwnedIp,
  15. bool? enableIAMDatabaseAuthentication,
  16. String? engine,
  17. int? iops,
  18. String? licenseModel,
  19. bool? multiAZ,
  20. String? optionGroupName,
  21. int? port,
  22. List<ProcessorFeature>? processorFeatures,
  23. bool? publiclyAccessible,
  24. String? storageType,
  25. List<Tag>? tags,
  26. String? tdeCredentialArn,
  27. String? tdeCredentialPassword,
  28. bool? useDefaultProcessorFeatures,
  29. List<String>? vpcSecurityGroupIds,
})

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most of the source's original configuration, including the default security group and DB parameter group. By default, the new DB instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.

If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original DB instance with the DB instance created from the snapshot.

If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

May throw DBInstanceAlreadyExistsFault. May throw DBSnapshotNotFoundFault. May throw InstanceQuotaExceededFault. May throw InsufficientDBInstanceCapacityFault. May throw InvalidDBSnapshotStateFault. May throw StorageQuotaExceededFault. May throw InvalidVPCNetworkStateFault. May throw InvalidRestoreFault. May throw DBSubnetGroupNotFoundFault. May throw DBSubnetGroupDoesNotCoverEnoughAZs. May throw InvalidSubnet. May throw ProvisionedIopsNotAvailableInAZFault. May throw OptionGroupNotFoundFault. May throw StorageTypeNotSupportedFault. May throw AuthorizationNotFoundFault. May throw KMSKeyNotAccessibleFault. May throw DBSecurityGroupNotFoundFault. May throw DomainNotFoundFault. May throw DBParameterGroupNotFoundFault. May throw BackupPolicyNotFoundFault.

Parameter dBInstanceIdentifier : Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.

Constraints:

  • Must contain from 1 to 63 numbers, letters, or hyphens
  • First character must be a letter
  • Can't end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id

Parameter dBSnapshotIdentifier : The identifier for the DB snapshot to restore from.

Constraints:

  • Must match the identifier of an existing DBSnapshot.
  • If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

Parameter autoMinorVersionUpgrade : A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.

Parameter availabilityZone : The Availability Zone (AZ) where the DB instance will be created.

Default: A random, system-chosen Availability Zone.

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

Example: us-east-1a

Parameter copyTagsToSnapshot : A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.

Parameter dBInstanceClass : The compute and memory capacity of the Amazon RDS 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.

Default: The same DBInstanceClass as the original DB instance.

Parameter dBName : The database name for the restored DB instance.

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.

Constraints:

  • If supplied, must match the name of an existing DBParameterGroup.
  • Must be 1 to 255 letters, numbers, or hyphens.
  • First character must be a letter.
  • Can't end with a hyphen or contain two consecutive hyphens.

Parameter dBSubnetGroupName : The DB subnet group name to use for the new instance.

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

Example: mySubnetgroup

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 domain : Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Parameter domainIAMRoleName : Specify the name of the IAM role to be used when making API calls to the Directory Service.

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 enableCustomerOwnedIp : A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

For more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses in the AWS Outposts 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 engine : The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

Valid Values:

  • mariadb
  • mysql
  • oracle-ee
  • oracle-se2
  • oracle-se1
  • oracle-se
  • postgres
  • sqlserver-ee
  • sqlserver-se
  • sqlserver-ex
  • sqlserver-web

Parameter iops : Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn't specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.

The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

Constraints: Must be an integer greater than 1000.

Parameter licenseModel : License model information for the restored DB instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

Parameter multiAZ : A value that indicates whether the DB instance is a Multi-AZ deployment.

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

Parameter optionGroupName : The name of the option group to be used for the restored DB instance.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

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

Default: The same port as the original DB instance

Constraints: Value must be 1150-65535

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 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 tdeCredentialArn : The ARN from the key store with which to associate the instance for TDE encryption.

Parameter tdeCredentialPassword : The password for the given ARN from the key store in order to access the device.

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 EC2 VPC security groups to associate with this DB instance.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

Implementation

Future<RestoreDBInstanceFromDBSnapshotResult>
    restoreDBInstanceFromDBSnapshot({
  required String dBInstanceIdentifier,
  required String dBSnapshotIdentifier,
  bool? autoMinorVersionUpgrade,
  String? availabilityZone,
  bool? copyTagsToSnapshot,
  String? dBInstanceClass,
  String? dBName,
  String? dBParameterGroupName,
  String? dBSubnetGroupName,
  bool? deletionProtection,
  String? domain,
  String? domainIAMRoleName,
  List<String>? enableCloudwatchLogsExports,
  bool? enableCustomerOwnedIp,
  bool? enableIAMDatabaseAuthentication,
  String? engine,
  int? iops,
  String? licenseModel,
  bool? multiAZ,
  String? optionGroupName,
  int? port,
  List<ProcessorFeature>? processorFeatures,
  bool? publiclyAccessible,
  String? storageType,
  List<Tag>? tags,
  String? tdeCredentialArn,
  String? tdeCredentialPassword,
  bool? useDefaultProcessorFeatures,
  List<String>? vpcSecurityGroupIds,
}) async {
  ArgumentError.checkNotNull(dBInstanceIdentifier, 'dBInstanceIdentifier');
  ArgumentError.checkNotNull(dBSnapshotIdentifier, 'dBSnapshotIdentifier');
  final $request = <String, dynamic>{};
  $request['DBInstanceIdentifier'] = dBInstanceIdentifier;
  $request['DBSnapshotIdentifier'] = dBSnapshotIdentifier;
  autoMinorVersionUpgrade
      ?.also((arg) => $request['AutoMinorVersionUpgrade'] = arg);
  availabilityZone?.also((arg) => $request['AvailabilityZone'] = arg);
  copyTagsToSnapshot?.also((arg) => $request['CopyTagsToSnapshot'] = arg);
  dBInstanceClass?.also((arg) => $request['DBInstanceClass'] = arg);
  dBName?.also((arg) => $request['DBName'] = arg);
  dBParameterGroupName?.also((arg) => $request['DBParameterGroupName'] = arg);
  dBSubnetGroupName?.also((arg) => $request['DBSubnetGroupName'] = arg);
  deletionProtection?.also((arg) => $request['DeletionProtection'] = arg);
  domain?.also((arg) => $request['Domain'] = arg);
  domainIAMRoleName?.also((arg) => $request['DomainIAMRoleName'] = arg);
  enableCloudwatchLogsExports
      ?.also((arg) => $request['EnableCloudwatchLogsExports'] = arg);
  enableCustomerOwnedIp
      ?.also((arg) => $request['EnableCustomerOwnedIp'] = arg);
  enableIAMDatabaseAuthentication
      ?.also((arg) => $request['EnableIAMDatabaseAuthentication'] = arg);
  engine?.also((arg) => $request['Engine'] = arg);
  iops?.also((arg) => $request['Iops'] = arg);
  licenseModel?.also((arg) => $request['LicenseModel'] = arg);
  multiAZ?.also((arg) => $request['MultiAZ'] = arg);
  optionGroupName?.also((arg) => $request['OptionGroupName'] = arg);
  port?.also((arg) => $request['Port'] = arg);
  processorFeatures?.also((arg) => $request['ProcessorFeatures'] = arg);
  publiclyAccessible?.also((arg) => $request['PubliclyAccessible'] = arg);
  storageType?.also((arg) => $request['StorageType'] = arg);
  tags?.also((arg) => $request['Tags'] = arg);
  tdeCredentialArn?.also((arg) => $request['TdeCredentialArn'] = arg);
  tdeCredentialPassword
      ?.also((arg) => $request['TdeCredentialPassword'] = arg);
  useDefaultProcessorFeatures
      ?.also((arg) => $request['UseDefaultProcessorFeatures'] = arg);
  vpcSecurityGroupIds?.also((arg) => $request['VpcSecurityGroupIds'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'RestoreDBInstanceFromDBSnapshot',
    version: '2014-10-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['RestoreDBInstanceFromDBSnapshotMessage'],
    shapes: shapes,
    resultWrapper: 'RestoreDBInstanceFromDBSnapshotResult',
  );
  return RestoreDBInstanceFromDBSnapshotResult.fromXml($result);
}