Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RDS.RestoreDBInstanceFromS3

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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 command doesn't apply to RDS Custom.

Synopsis

Creating a Request

data RestoreDBInstanceFromS3 Source #

See: newRestoreDBInstanceFromS3 smart constructor.

Constructors

RestoreDBInstanceFromS3'

Fields

allocatedStorage :: Maybe Int
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.
autoMinorVersionUpgrade :: Maybe Bool
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.
availabilityZone :: Maybe Text
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.
backupRetentionPeriod :: Maybe Int
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance.
copyTagsToSnapshot :: Maybe Bool
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.
dbName :: Maybe Text
The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.
dbParameterGroupName :: Maybe Text
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.
dbSecurityGroups :: Maybe [Text]
A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
dbSubnetGroupName :: Maybe Text
A DB subnet group to associate with this DB instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
deletionProtection :: Maybe Bool
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 isn't enabled. For more information, see Deleting a DB Instance.
enableCloudwatchLogsExports :: Maybe [Text]
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.
enableIAMDatabaseAuthentication :: Maybe Bool
A value that indicates 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.
enablePerformanceInsights :: Maybe Bool
A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
engineVersion :: Maybe Text
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.
iops :: Maybe Int
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.
kmsKeyId :: Maybe Text
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.
licenseModel :: Maybe Text
The license model for this DB instance. Use general-public-license.
manageMasterUserPassword :: Maybe Bool
A value that indicates 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.
masterUserPassword :: Maybe Text
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
Constraints: Can't be specified if ManageMasterUserPassword is turned on.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
masterUserSecretKmsKeyId :: Maybe Text
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.
masterUsername :: Maybe Text
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.
maxAllocatedStorage :: Maybe Int
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.
monitoringInterval :: Maybe Int
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 :: Maybe Text
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.
multiAZ :: Maybe Bool
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.
networkType :: Maybe Text
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.
optionGroupName :: Maybe Text
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.
performanceInsightsKMSKeyId :: Maybe Text
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 :: Maybe Int
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.
port :: Maybe Int
The port number on which the database accepts connections.
Type: Integer
Valid Values: 1150-65535
Default: 3306
preferredBackupWindow :: Maybe Text
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.
preferredMaintenanceWindow :: Maybe Text
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.
processorFeatures :: Maybe [ProcessorFeature]
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
publiclyAccessible :: Maybe Bool
A value that indicates 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.
s3Prefix :: Maybe Text
The prefix of your Amazon S3 bucket.
storageEncrypted :: Maybe Bool
A value that indicates whether the new DB instance is encrypted or not.
storageThroughput :: Maybe Int
Specifies the storage throughput value for the DB instance.
This setting doesn't apply to RDS Custom or Amazon Aurora.
storageType :: Maybe Text
Specifies the storage type to be associated with the DB instance.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1 or gp3, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified; otherwise gp2
tags :: Maybe [Tag]
A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
useDefaultProcessorFeatures :: Maybe Bool
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
vpcSecurityGroupIds :: Maybe [Text]
A list of VPC security groups to associate with this DB instance.
dbInstanceIdentifier :: Text
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
dbInstanceClass :: Text
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 :: Text
The name of the database engine to be used for this instance.
Valid Values: mysql
sourceEngine :: Text
The name of the engine of your source database.
Valid Values: mysql
sourceEngineVersion :: Text
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 :: Text
The name of your Amazon S3 bucket that contains your database backup file.
s3IngestionRoleArn :: Text
An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.

Instances

Instances details

ToHeaders RestoreDBInstanceFromS3 Source #
Instance details Defined in Amazonka.RDS.RestoreDBInstanceFromS3 Methods toHeaders :: RestoreDBInstanceFromS3 -> [Header] #
ToPath RestoreDBInstanceFromS3 Source #
Instance details Defined in Amazonka.RDS.RestoreDBInstanceFromS3 Methods toPath :: RestoreDBInstanceFromS3 -> ByteString #
ToQuery RestoreDBInstanceFromS3 Source #
Instance details Defined in Amazonka.RDS.RestoreDBInstanceFromS3 Methods toQuery :: RestoreDBInstanceFromS3 -> QueryString #
AWSRequest RestoreDBInstanceFromS3 Source #
Instance details Defined in Amazonka.RDS.RestoreDBInstanceFromS3 Associated Types type AWSResponse RestoreDBInstanceFromS3 # Methods request :: (Service -> Service) -> RestoreDBInstanceFromS3 -> Request RestoreDBInstanceFromS3 # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RestoreDBInstanceFromS3 -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RestoreDBInstanceFromS3))) #
Generic RestoreDBInstanceFromS3 Source #
Instance details Defined in Amazonka.RDS.RestoreDBInstanceFromS3 Associated Types type Rep RestoreDBInstanceFromS3 :: Type -> Type # Methods from :: RestoreDBInstanceFromS3 -> Rep RestoreDBInstanceFromS3 x # to :: Rep RestoreDBInstanceFromS3 x -> RestoreDBInstanceFromS3 #
Read RestoreDBInstanceFromS3 Source #
Instance details Defined in Amazonka.RDS.RestoreDBInstanceFromS3 Methods readsPrec :: Int -> ReadS RestoreDBInstanceFromS3 # readList :: ReadS [RestoreDBInstanceFromS3] # readPrec :: ReadPrec RestoreDBInstanceFromS3 # readListPrec :: ReadPrec [RestoreDBInstanceFromS3] #
Show RestoreDBInstanceFromS3 Source #
Instance details Defined in Amazonka.RDS.RestoreDBInstanceFromS3 Methods showsPrec :: Int -> RestoreDBInstanceFromS3 -> ShowS # show :: RestoreDBInstanceFromS3 -> String # showList :: [RestoreDBInstanceFromS3] -> ShowS #
NFData RestoreDBInstanceFromS3 Source #
Instance details Defined in Amazonka.RDS.RestoreDBInstanceFromS3 Methods rnf :: RestoreDBInstanceFromS3 -> () #
Eq RestoreDBInstanceFromS3 Source #
Instance details Defined in Amazonka.RDS.RestoreDBInstanceFromS3 Methods (==) :: RestoreDBInstanceFromS3 -> RestoreDBInstanceFromS3 -> Bool # (/=) :: RestoreDBInstanceFromS3 -> RestoreDBInstanceFromS3 -> Bool #
Hashable RestoreDBInstanceFromS3 Source #
Instance details Defined in Amazonka.RDS.RestoreDBInstanceFromS3 Methods hashWithSalt :: Int -> RestoreDBInstanceFromS3 -> Int # hash :: RestoreDBInstanceFromS3 -> Int #
type AWSResponse RestoreDBInstanceFromS3 Source #
Instance details Defined in Amazonka.RDS.RestoreDBInstanceFromS3 type AWSResponse RestoreDBInstanceFromS3 = RestoreDBInstanceFromS3Response
type Rep RestoreDBInstanceFromS3 Source #
Instance details Defined in Amazonka.RDS.RestoreDBInstanceFromS3 type Rep RestoreDBInstanceFromS3 = D1 ('MetaData "RestoreDBInstanceFromS3" "Amazonka.RDS.RestoreDBInstanceFromS3" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "RestoreDBInstanceFromS3'" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "allocatedStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "autoMinorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "backupRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "copyTagsToSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "dbName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "dbParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "dbSecurityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "dbSubnetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "enableCloudwatchLogsExports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "enableIAMDatabaseAuthentication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))) :: (((S1 ('MetaSel ('Just "enablePerformanceInsights") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "iops") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "licenseModel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "manageMasterUserPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: ((S1 ('MetaSel ('Just "masterUserPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "masterUserSecretKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "masterUsername") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "maxAllocatedStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "monitoringInterval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "monitoringRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))) :: ((((S1 ('MetaSel ('Just "multiAZ") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "networkType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "optionGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "performanceInsightsKMSKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "performanceInsightsRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :: ((S1 ('MetaSel ('Just "preferredBackupWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "processorFeatures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProcessorFeature])))) :: (S1 ('MetaSel ('Just "publiclyAccessible") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "s3Prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "storageEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))) :: (((S1 ('MetaSel ('Just "storageThroughput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "storageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :: (S1 ('MetaSel ('Just "useDefaultProcessorFeatures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "vpcSecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :: ((S1 ('MetaSel ('Just "dbInstanceClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "sourceEngine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "sourceEngineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "s3BucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "s3IngestionRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))))

newRestoreDBInstanceFromS3 Source #

Arguments

:: Text	`RestoreDBInstanceFromS3`
-> Text	`RestoreDBInstanceFromS3`
-> Text	`RestoreDBInstanceFromS3`
-> Text	`$sel:sourceEngine:RestoreDBInstanceFromS3'`
-> Text	`$sel:sourceEngineVersion:RestoreDBInstanceFromS3'`
-> Text	`$sel:s3BucketName:RestoreDBInstanceFromS3'`
-> Text	`$sel:s3IngestionRoleArn:RestoreDBInstanceFromS3'`
-> RestoreDBInstanceFromS3

Create a value of RestoreDBInstanceFromS3 with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_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.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_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.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_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.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_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.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_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.

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

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_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.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_dbSecurityGroups - A list of DB security groups to associate with this DB instance.

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

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_dbSubnetGroupName - A DB subnet group to associate with this DB instance.

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

Example: mydbsubnetgroup

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_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 isn't enabled. For more information, see Deleting a DB Instance.

$sel:enableCloudwatchLogsExports:RestoreDBInstanceFromS3', restoreDBInstanceFromS3_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.

$sel:enableIAMDatabaseAuthentication:RestoreDBInstanceFromS3', restoreDBInstanceFromS3_enableIAMDatabaseAuthentication - A value that indicates 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.

$sel:enablePerformanceInsights:RestoreDBInstanceFromS3', restoreDBInstanceFromS3_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 RDS User Guide.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_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.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_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.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_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.

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

$sel:manageMasterUserPassword:RestoreDBInstanceFromS3', restoreDBInstanceFromS3_manageMasterUserPassword - A value that indicates 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.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_masterUserPassword - The password for the master user. The password can include any printable ASCII character except "/", """, or "@".

Constraints: Can't be specified if ManageMasterUserPassword is turned on.

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

$sel:masterUserSecretKmsKeyId:RestoreDBInstanceFromS3', restoreDBInstanceFromS3_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.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_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.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_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.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_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

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_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.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_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.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_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.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_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.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_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.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_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.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_port - The port number on which the database accepts connections.

Type: Integer

Valid Values: 1150-65535

Default: 3306

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_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.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_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.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_processorFeatures - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_publiclyAccessible - A value that indicates 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.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_s3Prefix - The prefix of your Amazon S3 bucket.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_storageEncrypted - A value that indicates whether the new DB instance is encrypted or not.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_storageThroughput - Specifies the storage throughput value for the DB instance.

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

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_storageType - Specifies the storage type to be associated with the DB instance.

Valid values: gp2 | gp3 | io1 | standard

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

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

$sel:tags:RestoreDBInstanceFromS3', restoreDBInstanceFromS3_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.

$sel:useDefaultProcessorFeatures:RestoreDBInstanceFromS3', restoreDBInstanceFromS3_useDefaultProcessorFeatures - A value that indicates whether the DB instance class of the DB instance uses its default processor features.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_vpcSecurityGroupIds - A list of VPC security groups to associate with this DB instance.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_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

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_dbInstanceClass - 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.

RestoreDBInstanceFromS3, restoreDBInstanceFromS3_engine - The name of the database engine to be used for this instance.

Valid Values: mysql

$sel:sourceEngine:RestoreDBInstanceFromS3', restoreDBInstanceFromS3_sourceEngine - The name of the engine of your source database.

Valid Values: mysql

$sel:sourceEngineVersion:RestoreDBInstanceFromS3', restoreDBInstanceFromS3_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

$sel:s3BucketName:RestoreDBInstanceFromS3', restoreDBInstanceFromS3_s3BucketName - The name of your Amazon S3 bucket that contains your database backup file.

$sel:s3IngestionRoleArn:RestoreDBInstanceFromS3', restoreDBInstanceFromS3_s3IngestionRoleArn - An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.

Request Lenses

restoreDBInstanceFromS3_allocatedStorage :: Lens' RestoreDBInstanceFromS3 (Maybe Int) Source #

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.

restoreDBInstanceFromS3_autoMinorVersionUpgrade :: Lens' RestoreDBInstanceFromS3 (Maybe Bool) Source #

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.

restoreDBInstanceFromS3_availabilityZone :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

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.

restoreDBInstanceFromS3_backupRetentionPeriod :: Lens' RestoreDBInstanceFromS3 (Maybe Int) Source #

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

restoreDBInstanceFromS3_copyTagsToSnapshot :: Lens' RestoreDBInstanceFromS3 (Maybe Bool) Source #

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.

restoreDBInstanceFromS3_dbName :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

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

restoreDBInstanceFromS3_dbParameterGroupName :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

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.

restoreDBInstanceFromS3_dbSecurityGroups :: Lens' RestoreDBInstanceFromS3 (Maybe [Text]) Source #

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

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

restoreDBInstanceFromS3_dbSubnetGroupName :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

A DB subnet group to associate with this DB instance.

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

Example: mydbsubnetgroup

restoreDBInstanceFromS3_deletionProtection :: Lens' RestoreDBInstanceFromS3 (Maybe Bool) Source #

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 isn't enabled. For more information, see Deleting a DB Instance.

restoreDBInstanceFromS3_enableCloudwatchLogsExports :: Lens' RestoreDBInstanceFromS3 (Maybe [Text]) Source #

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.

restoreDBInstanceFromS3_enableIAMDatabaseAuthentication :: Lens' RestoreDBInstanceFromS3 (Maybe Bool) Source #

A value that indicates 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.

restoreDBInstanceFromS3_enablePerformanceInsights :: Lens' RestoreDBInstanceFromS3 (Maybe Bool) Source #

A value that indicates whether to enable Performance Insights for the DB instance.

For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

restoreDBInstanceFromS3_engineVersion :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

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.

restoreDBInstanceFromS3_iops :: Lens' RestoreDBInstanceFromS3 (Maybe Int) Source #

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.

restoreDBInstanceFromS3_kmsKeyId :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

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.

restoreDBInstanceFromS3_licenseModel :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

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

restoreDBInstanceFromS3_manageMasterUserPassword :: Lens' RestoreDBInstanceFromS3 (Maybe Bool) Source #

A value that indicates 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.

restoreDBInstanceFromS3_masterUserPassword :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

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

Constraints: Can't be specified if ManageMasterUserPassword is turned on.

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

restoreDBInstanceFromS3_masterUserSecretKmsKeyId :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

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.

restoreDBInstanceFromS3_masterUsername :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

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.

restoreDBInstanceFromS3_maxAllocatedStorage :: Lens' RestoreDBInstanceFromS3 (Maybe Int) Source #

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.

restoreDBInstanceFromS3_monitoringInterval :: Lens' RestoreDBInstanceFromS3 (Maybe Int) Source #

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

restoreDBInstanceFromS3_monitoringRoleArn :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

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.

restoreDBInstanceFromS3_multiAZ :: Lens' RestoreDBInstanceFromS3 (Maybe Bool) Source #

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.

restoreDBInstanceFromS3_networkType :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

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.

restoreDBInstanceFromS3_optionGroupName :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

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.

restoreDBInstanceFromS3_performanceInsightsKMSKeyId :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

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.

restoreDBInstanceFromS3_performanceInsightsRetentionPeriod :: Lens' RestoreDBInstanceFromS3 (Maybe Int) Source #

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.

restoreDBInstanceFromS3_port :: Lens' RestoreDBInstanceFromS3 (Maybe Int) Source #

The port number on which the database accepts connections.

Type: Integer

Valid Values: 1150-65535

Default: 3306

restoreDBInstanceFromS3_preferredBackupWindow :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

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.

restoreDBInstanceFromS3_preferredMaintenanceWindow :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

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.

restoreDBInstanceFromS3_processorFeatures :: Lens' RestoreDBInstanceFromS3 (Maybe [ProcessorFeature]) Source #

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

restoreDBInstanceFromS3_publiclyAccessible :: Lens' RestoreDBInstanceFromS3 (Maybe Bool) Source #

A value that indicates 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.

restoreDBInstanceFromS3_s3Prefix :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

The prefix of your Amazon S3 bucket.

restoreDBInstanceFromS3_storageEncrypted :: Lens' RestoreDBInstanceFromS3 (Maybe Bool) Source #

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

restoreDBInstanceFromS3_storageThroughput :: Lens' RestoreDBInstanceFromS3 (Maybe Int) Source #

Specifies the storage throughput value for the DB instance.

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

restoreDBInstanceFromS3_storageType :: Lens' RestoreDBInstanceFromS3 (Maybe Text) Source #

Specifies the storage type to be associated with the DB instance.

Valid values: gp2 | gp3 | io1 | standard

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

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

restoreDBInstanceFromS3_tags :: Lens' RestoreDBInstanceFromS3 (Maybe [Tag]) Source #

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

restoreDBInstanceFromS3_useDefaultProcessorFeatures :: Lens' RestoreDBInstanceFromS3 (Maybe Bool) Source #

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

restoreDBInstanceFromS3_vpcSecurityGroupIds :: Lens' RestoreDBInstanceFromS3 (Maybe [Text]) Source #

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

restoreDBInstanceFromS3_dbInstanceIdentifier :: Lens' RestoreDBInstanceFromS3 Text Source #

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

restoreDBInstanceFromS3_dbInstanceClass :: Lens' RestoreDBInstanceFromS3 Text Source #

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.

restoreDBInstanceFromS3_engine :: Lens' RestoreDBInstanceFromS3 Text Source #

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

Valid Values: mysql

restoreDBInstanceFromS3_sourceEngine :: Lens' RestoreDBInstanceFromS3 Text Source #

The name of the engine of your source database.

Valid Values: mysql

restoreDBInstanceFromS3_sourceEngineVersion :: Lens' RestoreDBInstanceFromS3 Text Source #

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

restoreDBInstanceFromS3_s3BucketName :: Lens' RestoreDBInstanceFromS3 Text Source #

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

restoreDBInstanceFromS3_s3IngestionRoleArn :: Lens' RestoreDBInstanceFromS3 Text Source #

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

Destructuring the Response

data RestoreDBInstanceFromS3Response Source #

See: newRestoreDBInstanceFromS3Response smart constructor.

Constructors

RestoreDBInstanceFromS3Response'
Fields dbInstance :: Maybe DBInstance httpStatus :: Int The response's http status code.

Instances

Instances details

Generic RestoreDBInstanceFromS3Response Source #
Instance details Defined in Amazonka.RDS.RestoreDBInstanceFromS3 Associated Types type Rep RestoreDBInstanceFromS3Response :: Type -> Type # Methods from :: RestoreDBInstanceFromS3Response -> Rep RestoreDBInstanceFromS3Response x # to :: Rep RestoreDBInstanceFromS3Response x -> RestoreDBInstanceFromS3Response #
Read RestoreDBInstanceFromS3Response Source #
Instance details Defined in Amazonka.RDS.RestoreDBInstanceFromS3 Methods readsPrec :: Int -> ReadS RestoreDBInstanceFromS3Response # readList :: ReadS [RestoreDBInstanceFromS3Response] # readPrec :: ReadPrec RestoreDBInstanceFromS3Response # readListPrec :: ReadPrec [RestoreDBInstanceFromS3Response] #
Show RestoreDBInstanceFromS3Response Source #
Instance details Defined in Amazonka.RDS.RestoreDBInstanceFromS3 Methods showsPrec :: Int -> RestoreDBInstanceFromS3Response -> ShowS # show :: RestoreDBInstanceFromS3Response -> String # showList :: [RestoreDBInstanceFromS3Response] -> ShowS #
NFData RestoreDBInstanceFromS3Response Source #
Instance details Defined in Amazonka.RDS.RestoreDBInstanceFromS3 Methods rnf :: RestoreDBInstanceFromS3Response -> () #
Eq RestoreDBInstanceFromS3Response Source #
Instance details Defined in Amazonka.RDS.RestoreDBInstanceFromS3 Methods (==) :: RestoreDBInstanceFromS3Response -> RestoreDBInstanceFromS3Response -> Bool # (/=) :: RestoreDBInstanceFromS3Response -> RestoreDBInstanceFromS3Response -> Bool #
type Rep RestoreDBInstanceFromS3Response Source #
Instance details Defined in Amazonka.RDS.RestoreDBInstanceFromS3 type Rep RestoreDBInstanceFromS3Response = D1 ('MetaData "RestoreDBInstanceFromS3Response" "Amazonka.RDS.RestoreDBInstanceFromS3" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "RestoreDBInstanceFromS3Response'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbInstance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBInstance)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRestoreDBInstanceFromS3Response Source #

Arguments

:: Int	`$sel:httpStatus:RestoreDBInstanceFromS3Response'`
-> RestoreDBInstanceFromS3Response

Create a value of RestoreDBInstanceFromS3Response with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dbInstance:RestoreDBInstanceFromS3Response', restoreDBInstanceFromS3Response_dbInstance - Undocumented member.

$sel:httpStatus:RestoreDBInstanceFromS3Response', restoreDBInstanceFromS3Response_httpStatus - The response's http status code.

Response Lenses

restoreDBInstanceFromS3Response_dbInstance :: Lens' RestoreDBInstanceFromS3Response (Maybe DBInstance) Source #

Undocumented member.

restoreDBInstanceFromS3Response_httpStatus :: Lens' RestoreDBInstanceFromS3Response Int Source #

The response's http status code.