AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the RestoreDBInstanceFromS3 operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.RDS.AmazonRDSRequest
      Amazon.RDS.Model.RestoreDBInstanceFromS3Request

Namespace: Amazon.RDS.Model
Assembly: AWSSDK.RDS.dll
Version: 3.x.y.z

Syntax

C#
public class RestoreDBInstanceFromS3Request : AmazonRDSRequest
         IAmazonWebServiceRequest

The RestoreDBInstanceFromS3Request type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AllocatedStorage System.Int32

Gets and sets the property AllocatedStorage.

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.

Public Property AutoMinorVersionUpgrade System.Boolean

Gets and sets the property AutoMinorVersionUpgrade.

True to indicate that minor engine upgrades are applied automatically to the DB instance during the maintenance window, and otherwise false.

Default: true

Public Property AvailabilityZone System.String

Gets and sets the property AvailabilityZone.

The Availability Zone that the DB instance is created in. For information about AWS Regions and Availability Zones, see Regions and Availability Zones.

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 MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.

Public Property BackupRetentionPeriod System.Int32

Gets and sets the property 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.

Public Property CopyTagsToSnapshot System.Boolean

Gets and sets the property CopyTagsToSnapshot.

True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false.

Default: false.

Public Property DBInstanceClass System.String

Gets and sets the property 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 is not supported on the db.t2.micro DB instance class.

Public Property DBInstanceIdentifier System.String

Gets and sets the property 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.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

Public Property DBName System.String

Gets and sets the property DBName.

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

Public Property DBParameterGroupName System.String

Gets and sets the property DBParameterGroupName.

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.

Public Property DBSecurityGroups System.Collections.Generic.List<System.String>

Gets and sets the property DBSecurityGroups.

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

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

Public Property DBSubnetGroupName System.String

Gets and sets the property DBSubnetGroupName.

A DB subnet group to associate with this DB instance.

Public Property EnableCloudwatchLogsExports System.Collections.Generic.List<System.String>

Gets and sets the property 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 Relational Database Service User Guide.

Public Property EnableIAMDatabaseAuthentication System.Boolean

Gets and sets the property EnableIAMDatabaseAuthentication.

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

Public Property EnablePerformanceInsights System.Boolean

Gets and sets the property EnablePerformanceInsights.

True to enable Performance Insights for the DB instance, and otherwise false.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

Public Property Engine System.String

Gets and sets the property Engine.

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

Valid Values: mysql

Public Property EngineVersion System.String

Gets and sets the property 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.

Public Property Iops System.Int32

Gets and sets the property 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 see Amazon RDS Provisioned IOPS Storage to Improve Performance.

Public Property KmsKeyId System.String

Gets and sets the property KmsKeyId.

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 true, 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.

Public Property LicenseModel System.String

Gets and sets the property LicenseModel.

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

Public Property MasterUsername System.String

Gets and sets the property MasterUsername.

The name for the master user.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Cannot be a reserved word for the chosen database engine.

Public Property MasterUserPassword System.String

Gets and sets the property 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.

Public Property MonitoringInterval System.Int32

Gets and sets the property 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

Public Property MonitoringRoleArn System.String

Gets and sets the property 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.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

Public Property MultiAZ System.Boolean

Gets and sets the property MultiAZ.

Specifies whether the DB instance is a Multi-AZ deployment. If MultiAZ is set to true, you can't set the AvailabilityZone parameter.

Public Property OptionGroupName System.String

Gets and sets the property 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.

Public Property PerformanceInsightsKMSKeyId System.String

Gets and sets the property PerformanceInsightsKMSKeyId.

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.

Public Property PerformanceInsightsRetentionPeriod System.Int32

Gets and sets the property PerformanceInsightsRetentionPeriod.

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

Public Property Port System.Int32

Gets and sets the property Port.

The port number on which the database accepts connections.

Type: Integer

Valid Values: 1150-65535

Default: 3306

Public Property PreferredBackupWindow System.String

Gets and sets the property PreferredBackupWindow.

The time range each day during which automated backups are created if automated backups are enabled. For more information, see The Backup Window.

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.

Public Property PreferredMaintenanceWindow System.String

Gets and sets the property 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.

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.

Public Property ProcessorFeatures System.Collections.Generic.List<Amazon.RDS.Model.ProcessorFeature>

Gets and sets the property ProcessorFeatures.

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

Public Property PubliclyAccessible System.Boolean

Gets and sets the property PubliclyAccessible.

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

Public Property S3BucketName System.String

Gets and sets the property S3BucketName.

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

Public Property S3IngestionRoleArn System.String

Gets and sets the property S3IngestionRoleArn.

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

Public Property S3Prefix System.String

Gets and sets the property S3Prefix.

The prefix of your Amazon S3 bucket.

Public Property SourceEngine System.String

Gets and sets the property SourceEngine.

The name of the engine of your source database.

Valid Values: mysql

Public Property SourceEngineVersion System.String

Gets and sets the property SourceEngineVersion.

The engine version of your source database.

Valid Values: 5.6

Public Property StorageEncrypted System.Boolean

Gets and sets the property StorageEncrypted.

Specifies whether the new DB instance is encrypted or not.

Public Property StorageType System.String

Gets and sets the property 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 standard

Public Property Tags System.Collections.Generic.List<Amazon.RDS.Model.Tag>

Gets and sets the property Tags.

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

Public Property UseDefaultProcessorFeatures System.Boolean

Gets and sets the property UseDefaultProcessorFeatures.

A value that specifies that the DB instance class of the DB instance uses its default processor features.

Public Property VpcSecurityGroupIds System.Collections.Generic.List<System.String>

Gets and sets the property VpcSecurityGroupIds.

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

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms