Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.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 .

Synopsis

Creating a Request

restoreDBInstanceFromS3 Source #

Arguments

:: Text	`rdifsDBInstanceIdentifier`
-> Text	`rdifsDBInstanceClass`
-> Text	`rdifsEngine`
-> Text	`rdifsSourceEngine`
-> Text	`rdifsSourceEngineVersion`
-> Text	`rdifsS3BucketName`
-> Text	`rdifsS3IngestionRoleARN`
-> RestoreDBInstanceFromS3

Creates a value of RestoreDBInstanceFromS3 with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rdifsEngineVersion - The version number of the database engine to use. Choose the latest minor version of your database engine as specified in CreateDBInstance .
rdifsDBSecurityGroups - A list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine.
rdifsStorageEncrypted - Specifies whether the new DB instance is encrypted or not.
rdifsMasterUserPassword - The password for the master user. The password can include any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters.
rdifsPubliclyAccessible - Specifies whether the DB instance is publicly accessible or not. For more information, see CreateDBInstance .
rdifsAutoMinorVersionUpgrade - True to indicate that minor engine upgrades are applied automatically to the DB instance during the maintenance window, and otherwise false. Default: true
rdifsMasterUsername - 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.
rdifsDBSubnetGroupName - A DB subnet group to associate with this DB instance.
rdifsMonitoringRoleARN - 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.
rdifsIOPS - The amount of Provisioned IOPS (inputoutput operations per second) to allocate initially for the DB instance. For information about valid Iops values, see see <http:docs.aws.amazon.comAmazonRDSlatestUserGuide/CHAP_Storage.html#USER_PIOPS Amazon RDS Provisioned IOPS Storage to Improve Performance> .
rdifsMonitoringInterval - 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
rdifsLicenseModel - The license model for this DB instance. Use general-public-license .
rdifsPreferredMaintenanceWindow - 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.
rdifsEnablePerformanceInsights - True to enable Performance Insights for the DB instance, and otherwise false.
rdifsKMSKeyId - 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.
rdifsDBParameterGroupName - 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.
rdifsPreferredBackupWindow - 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.
rdifsAvailabilityZone - 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.
rdifsBackupRetentionPeriod - The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance .
rdifsPerformanceInsightsKMSKeyId - 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.
rdifsVPCSecurityGroupIds - A list of VPC security groups to associate with this DB instance.
rdifsMultiAZ - Specifies whether the DB instance is a Multi-AZ deployment. If MultiAZ is set to true , you can't set the AvailabilityZone parameter.
rdifsS3Prefix - The prefix of your Amazon S3 bucket.
rdifsAllocatedStorage - The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance .
rdifsOptionGroupName - 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.
rdifsCopyTagsToSnapshot - True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. Default: false.
rdifsTags - A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources .
rdifsPort - The port number on which the database accepts connections. Type: Integer Valid Values: 1150 -65535 Default: 3306
rdifsEnableIAMDatabaseAuthentication - True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false
rdifsStorageType - 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
rdifsEnableCloudwatchLogsExports - The list of logs that the restored DB instance is to export to CloudWatch Logs.
rdifsDBName - The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance .
rdifsDBInstanceIdentifier - 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
rdifsDBInstanceClass - 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.
rdifsEngine - The name of the database engine to be used for this instance. Valid Values: mysql
rdifsSourceEngine - The name of the engine of your source database. Valid Values: mysql
rdifsSourceEngineVersion - The engine version of your source database. Valid Values: 5.6
rdifsS3BucketName - The name of your Amazon S3 bucket that contains your database backup file.
rdifsS3IngestionRoleARN - An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.

data RestoreDBInstanceFromS3 Source #

See: restoreDBInstanceFromS3 smart constructor.

Instances

Eq RestoreDBInstanceFromS3 Source #
Methods (==) :: RestoreDBInstanceFromS3 -> RestoreDBInstanceFromS3 -> Bool # (/=) :: RestoreDBInstanceFromS3 -> RestoreDBInstanceFromS3 -> Bool #
Data RestoreDBInstanceFromS3 Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RestoreDBInstanceFromS3 -> c RestoreDBInstanceFromS3 # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RestoreDBInstanceFromS3 # toConstr :: RestoreDBInstanceFromS3 -> Constr # dataTypeOf :: RestoreDBInstanceFromS3 -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c RestoreDBInstanceFromS3) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RestoreDBInstanceFromS3) # gmapT :: (forall b. Data b => b -> b) -> RestoreDBInstanceFromS3 -> RestoreDBInstanceFromS3 # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RestoreDBInstanceFromS3 -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RestoreDBInstanceFromS3 -> r # gmapQ :: (forall d. Data d => d -> u) -> RestoreDBInstanceFromS3 -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> RestoreDBInstanceFromS3 -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> RestoreDBInstanceFromS3 -> m RestoreDBInstanceFromS3 # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RestoreDBInstanceFromS3 -> m RestoreDBInstanceFromS3 # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RestoreDBInstanceFromS3 -> m RestoreDBInstanceFromS3 #
Read RestoreDBInstanceFromS3 Source #
Methods readsPrec :: Int -> ReadS RestoreDBInstanceFromS3 # readList :: ReadS [RestoreDBInstanceFromS3] # readPrec :: ReadPrec RestoreDBInstanceFromS3 # readListPrec :: ReadPrec [RestoreDBInstanceFromS3] #
Show RestoreDBInstanceFromS3 Source #
Methods showsPrec :: Int -> RestoreDBInstanceFromS3 -> ShowS # show :: RestoreDBInstanceFromS3 -> String # showList :: [RestoreDBInstanceFromS3] -> ShowS #
Generic RestoreDBInstanceFromS3 Source #
Associated Types type Rep RestoreDBInstanceFromS3 :: * -> * # Methods from :: RestoreDBInstanceFromS3 -> Rep RestoreDBInstanceFromS3 x # to :: Rep RestoreDBInstanceFromS3 x -> RestoreDBInstanceFromS3 #
Hashable RestoreDBInstanceFromS3 Source #
Methods hashWithSalt :: Int -> RestoreDBInstanceFromS3 -> Int # hash :: RestoreDBInstanceFromS3 -> Int #
NFData RestoreDBInstanceFromS3 Source #
Methods rnf :: RestoreDBInstanceFromS3 -> () #
AWSRequest RestoreDBInstanceFromS3 Source #
Associated Types type Rs RestoreDBInstanceFromS3 :: * # Methods request :: RestoreDBInstanceFromS3 -> Request RestoreDBInstanceFromS3 # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * RestoreDBInstanceFromS3 -> ClientResponse -> m (Response RestoreDBInstanceFromS3) #
ToHeaders RestoreDBInstanceFromS3 Source #
Methods toHeaders :: RestoreDBInstanceFromS3 -> [Header] #
ToPath RestoreDBInstanceFromS3 Source #
Methods toPath :: RestoreDBInstanceFromS3 -> ByteString #
ToQuery RestoreDBInstanceFromS3 Source #
Methods toQuery :: RestoreDBInstanceFromS3 -> QueryString #
type Rep RestoreDBInstanceFromS3 Source #
type Rep RestoreDBInstanceFromS3 = D1 * (MetaData "RestoreDBInstanceFromS3" "Network.AWS.RDS.RestoreDBInstanceFromS3" "amazonka-rds-1.6.0-1gpCa37cwlvAUzWljvprAs" False) (C1 * (MetaCons "RestoreDBInstanceFromS3'" PrefixI True) ((::) ((::) ((::) ((::) ((::) (S1 * (MetaSel (Just Symbol "_rdifsEngineVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_rdifsDBSecurityGroups") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text])))) ((::) (S1 * (MetaSel (Just Symbol "_rdifsStorageEncrypted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_rdifsMasterUserPassword") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((::) ((::) (S1 * (MetaSel (Just Symbol "_rdifsPubliclyAccessible") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_rdifsAutoMinorVersionUpgrade") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))) ((::) (S1 * (MetaSel (Just Symbol "_rdifsMasterUsername") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((::) (S1 * (MetaSel (Just Symbol "_rdifsDBSubnetGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_rdifsMonitoringRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))))) ((::) ((::) ((::) (S1 * (MetaSel (Just Symbol "_rdifsIOPS") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_rdifsMonitoringInterval") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int)))) ((::) (S1 * (MetaSel (Just Symbol "_rdifsLicenseModel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((::) (S1 * (MetaSel (Just Symbol "_rdifsPreferredMaintenanceWindow") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_rdifsEnablePerformanceInsights") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))))) ((::) ((::) (S1 * (MetaSel (Just Symbol "_rdifsKMSKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_rdifsDBParameterGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((::) (S1 * (MetaSel (Just Symbol "_rdifsPreferredBackupWindow") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((::) (S1 * (MetaSel (Just Symbol "_rdifsAvailabilityZone") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_rdifsBackupRetentionPeriod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int)))))))) ((::) ((::) ((::) ((::) (S1 * (MetaSel (Just Symbol "_rdifsPerformanceInsightsKMSKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_rdifsVPCSecurityGroupIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text])))) ((::) (S1 * (MetaSel (Just Symbol "_rdifsMultiAZ") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) ((::) (S1 * (MetaSel (Just Symbol "_rdifsS3Prefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_rdifsAllocatedStorage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int)))))) ((::) ((::) (S1 * (MetaSel (Just Symbol "_rdifsOptionGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_rdifsCopyTagsToSnapshot") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))) ((::) (S1 * (MetaSel (Just Symbol "_rdifsTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Tag]))) ((::) (S1 * (MetaSel (Just Symbol "_rdifsPort") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_rdifsEnableIAMDatabaseAuthentication") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))))))) ((::) ((::) ((::) (S1 * (MetaSel (Just Symbol "_rdifsStorageType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_rdifsEnableCloudwatchLogsExports") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text])))) ((::) (S1 * (MetaSel (Just Symbol "_rdifsDBName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((::) (S1 * (MetaSel (Just Symbol "_rdifsDBInstanceIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_rdifsDBInstanceClass") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))) ((::) ((::) (S1 * (MetaSel (Just Symbol "_rdifsEngine") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_rdifsSourceEngine") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))) ((::) (S1 * (MetaSel (Just Symbol "_rdifsSourceEngineVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((::) (S1 * (MetaSel (Just Symbol "_rdifsS3BucketName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_rdifsS3IngestionRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))))))
type Rs RestoreDBInstanceFromS3 Source #
type Rs RestoreDBInstanceFromS3 = RestoreDBInstanceFromS3Response

Request Lenses

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

The version number of the database engine to use. Choose the latest minor version of your database engine as specified in CreateDBInstance .

rdifsDBSecurityGroups :: Lens' RestoreDBInstanceFromS3 [Text] Source #

A list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine.

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

Specifies whether the new DB instance is encrypted or not.

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

The password for the master user. The password can include any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters.

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

Specifies whether the DB instance is publicly accessible or not. For more information, see CreateDBInstance .

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

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

rdifsMasterUsername :: 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. * Cannot be a reserved word for the chosen database engine.

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

A DB subnet group to associate with this DB instance.

rdifsMonitoringRoleARN :: 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 . If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

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

The amount of Provisioned IOPS (inputoutput operations per second) to allocate initially for the DB instance. For information about valid Iops values, see see <http:docs.aws.amazon.comAmazonRDSlatestUserGuide/CHAP_Storage.html#USER_PIOPS Amazon RDS Provisioned IOPS Storage to Improve Performance> .

rdifsMonitoringInterval :: 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

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

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

rdifsPreferredMaintenanceWindow :: 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 . 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.

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

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

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

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.

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

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.

rdifsPreferredBackupWindow :: 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 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.

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

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.

rdifsBackupRetentionPeriod :: 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 .

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

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.

rdifsVPCSecurityGroupIds :: Lens' RestoreDBInstanceFromS3 [Text] Source #

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

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

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

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

The prefix of your Amazon S3 bucket.

rdifsAllocatedStorage :: 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 .

rdifsOptionGroupName :: 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.

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

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

rdifsTags :: Lens' RestoreDBInstanceFromS3 [Tag] Source #

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

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

The port number on which the database accepts connections. Type: Integer Valid Values: 1150 -65535 Default: 3306

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

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

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

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

rdifsEnableCloudwatchLogsExports :: Lens' RestoreDBInstanceFromS3 [Text] Source #

The list of logs that the restored DB instance is to export to CloudWatch Logs.

rdifsDBName :: 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 .

rdifsDBInstanceIdentifier :: 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. * Cannot end with a hyphen or contain two consecutive hyphens. Example: mydbinstance

rdifsDBInstanceClass :: 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 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.

rdifsEngine :: Lens' RestoreDBInstanceFromS3 Text Source #

The name of the database engine to be used for this instance. Valid Values: mysql

rdifsSourceEngine :: Lens' RestoreDBInstanceFromS3 Text Source #

The name of the engine of your source database. Valid Values: mysql

rdifsSourceEngineVersion :: Lens' RestoreDBInstanceFromS3 Text Source #

The engine version of your source database. Valid Values: 5.6

rdifsS3BucketName :: Lens' RestoreDBInstanceFromS3 Text Source #

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

rdifsS3IngestionRoleARN :: Lens' RestoreDBInstanceFromS3 Text Source #

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

Destructuring the Response

restoreDBInstanceFromS3Response Source #

Arguments

:: Int	`rdifsrsResponseStatus`
-> RestoreDBInstanceFromS3Response

Creates a value of RestoreDBInstanceFromS3Response with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rdifsrsDBInstance - Undocumented member.
rdifsrsResponseStatus - -- | The response status code.

data RestoreDBInstanceFromS3Response Source #

See: restoreDBInstanceFromS3Response smart constructor.

Instances

Eq RestoreDBInstanceFromS3Response Source #
Methods (==) :: RestoreDBInstanceFromS3Response -> RestoreDBInstanceFromS3Response -> Bool # (/=) :: RestoreDBInstanceFromS3Response -> RestoreDBInstanceFromS3Response -> Bool #
Data RestoreDBInstanceFromS3Response Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RestoreDBInstanceFromS3Response -> c RestoreDBInstanceFromS3Response # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RestoreDBInstanceFromS3Response # toConstr :: RestoreDBInstanceFromS3Response -> Constr # dataTypeOf :: RestoreDBInstanceFromS3Response -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c RestoreDBInstanceFromS3Response) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RestoreDBInstanceFromS3Response) # gmapT :: (forall b. Data b => b -> b) -> RestoreDBInstanceFromS3Response -> RestoreDBInstanceFromS3Response # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RestoreDBInstanceFromS3Response -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RestoreDBInstanceFromS3Response -> r # gmapQ :: (forall d. Data d => d -> u) -> RestoreDBInstanceFromS3Response -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> RestoreDBInstanceFromS3Response -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> RestoreDBInstanceFromS3Response -> m RestoreDBInstanceFromS3Response # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RestoreDBInstanceFromS3Response -> m RestoreDBInstanceFromS3Response # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RestoreDBInstanceFromS3Response -> m RestoreDBInstanceFromS3Response #
Read RestoreDBInstanceFromS3Response Source #
Methods readsPrec :: Int -> ReadS RestoreDBInstanceFromS3Response # readList :: ReadS [RestoreDBInstanceFromS3Response] # readPrec :: ReadPrec RestoreDBInstanceFromS3Response # readListPrec :: ReadPrec [RestoreDBInstanceFromS3Response] #
Show RestoreDBInstanceFromS3Response Source #
Methods showsPrec :: Int -> RestoreDBInstanceFromS3Response -> ShowS # show :: RestoreDBInstanceFromS3Response -> String # showList :: [RestoreDBInstanceFromS3Response] -> ShowS #
Generic RestoreDBInstanceFromS3Response Source #
Associated Types type Rep RestoreDBInstanceFromS3Response :: * -> * # Methods from :: RestoreDBInstanceFromS3Response -> Rep RestoreDBInstanceFromS3Response x # to :: Rep RestoreDBInstanceFromS3Response x -> RestoreDBInstanceFromS3Response #
NFData RestoreDBInstanceFromS3Response Source #
Methods rnf :: RestoreDBInstanceFromS3Response -> () #
type Rep RestoreDBInstanceFromS3Response Source #
type Rep RestoreDBInstanceFromS3Response = D1 * (MetaData "RestoreDBInstanceFromS3Response" "Network.AWS.RDS.RestoreDBInstanceFromS3" "amazonka-rds-1.6.0-1gpCa37cwlvAUzWljvprAs" False) (C1 * (MetaCons "RestoreDBInstanceFromS3Response'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_rdifsrsDBInstance") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DBInstance))) (S1 * (MetaSel (Just Symbol "_rdifsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

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

Undocumented member.

rdifsrsResponseStatus :: Lens' RestoreDBInstanceFromS3Response Int Source #

- | The response status code.