Copyright | (c) 2013-2017 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 |
Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.
The target database is created with most of the original configuration, but in a system-selected availability zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.
- restoreDBInstanceToPointInTime :: Text -> Text -> RestoreDBInstanceToPointInTime
- data RestoreDBInstanceToPointInTime
- rditpitUseLatestRestorableTime :: Lens' RestoreDBInstanceToPointInTime (Maybe Bool)
- rditpitPubliclyAccessible :: Lens' RestoreDBInstanceToPointInTime (Maybe Bool)
- rditpitAutoMinorVersionUpgrade :: Lens' RestoreDBInstanceToPointInTime (Maybe Bool)
- rditpitDBSubnetGroupName :: Lens' RestoreDBInstanceToPointInTime (Maybe Text)
- rditpitRestoreTime :: Lens' RestoreDBInstanceToPointInTime (Maybe UTCTime)
- rditpitIOPS :: Lens' RestoreDBInstanceToPointInTime (Maybe Int)
- rditpitDomain :: Lens' RestoreDBInstanceToPointInTime (Maybe Text)
- rditpitEngine :: Lens' RestoreDBInstanceToPointInTime (Maybe Text)
- rditpitTDECredentialPassword :: Lens' RestoreDBInstanceToPointInTime (Maybe Text)
- rditpitDBInstanceClass :: Lens' RestoreDBInstanceToPointInTime (Maybe Text)
- rditpitLicenseModel :: Lens' RestoreDBInstanceToPointInTime (Maybe Text)
- rditpitAvailabilityZone :: Lens' RestoreDBInstanceToPointInTime (Maybe Text)
- rditpitMultiAZ :: Lens' RestoreDBInstanceToPointInTime (Maybe Bool)
- rditpitOptionGroupName :: Lens' RestoreDBInstanceToPointInTime (Maybe Text)
- rditpitCopyTagsToSnapshot :: Lens' RestoreDBInstanceToPointInTime (Maybe Bool)
- rditpitTDECredentialARN :: Lens' RestoreDBInstanceToPointInTime (Maybe Text)
- rditpitDomainIAMRoleName :: Lens' RestoreDBInstanceToPointInTime (Maybe Text)
- rditpitTags :: Lens' RestoreDBInstanceToPointInTime [Tag]
- rditpitPort :: Lens' RestoreDBInstanceToPointInTime (Maybe Int)
- rditpitEnableIAMDatabaseAuthentication :: Lens' RestoreDBInstanceToPointInTime (Maybe Bool)
- rditpitStorageType :: Lens' RestoreDBInstanceToPointInTime (Maybe Text)
- rditpitDBName :: Lens' RestoreDBInstanceToPointInTime (Maybe Text)
- rditpitSourceDBInstanceIdentifier :: Lens' RestoreDBInstanceToPointInTime Text
- rditpitTargetDBInstanceIdentifier :: Lens' RestoreDBInstanceToPointInTime Text
- restoreDBInstanceToPointInTimeResponse :: Int -> RestoreDBInstanceToPointInTimeResponse
- data RestoreDBInstanceToPointInTimeResponse
- rditpitrsDBInstance :: Lens' RestoreDBInstanceToPointInTimeResponse (Maybe DBInstance)
- rditpitrsResponseStatus :: Lens' RestoreDBInstanceToPointInTimeResponse Int
Creating a Request
restoreDBInstanceToPointInTime Source #
Creates a value of RestoreDBInstanceToPointInTime
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rditpitUseLatestRestorableTime
- Specifies whether (true
) or not (false
) the DB instance is restored from the latest backup time. Default:false
Constraints: Cannot be specified if RestoreTime parameter is provided.rditpitPubliclyAccessible
- 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. Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case. * Default VPC: true * VPC: false If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.rditpitAutoMinorVersionUpgrade
- Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.rditpitDBSubnetGroupName
- The DB subnet group name to use for the new instance. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example:mySubnetgroup
rditpitRestoreTime
- The date and time to restore from. Valid Values: Value must be a time in Universal Coordinated Time (UTC) format Constraints: * Must be before the latest restorable time for the DB instance * Cannot be specified if UseLatestRestorableTime parameter is true Example:2009-09-07T23:45:00Z
rditpitIOPS
- The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. Constraints: Must be an integer greater than 1000. SQL Server Setting the IOPS value for the SQL Server database engine is not supported.rditpitDomain
- Specify the Active Directory Domain to restore the instance in.rditpitEngine
- The database engine to use for the new instance. Default: The same as source Constraint: Must be compatible with the engine of the source Valid Values: *aurora
*mariadb
*mysql
*oracle-ee
*oracle-se2
*oracle-se1
*oracle-se
*postgres
*sqlserver-ee
*sqlserver-se
*sqlserver-ex
*sqlserver-web
rditpitTDECredentialPassword
- The password for the given ARN from the Key Store in order to access the device.rditpitDBInstanceClass
- The compute and memory capacity of the Amazon RDS DB instance, for example,db.m4.large
. Not all DB instance classes are available in all regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Default: The same DBInstanceClass as the original DB instance.rditpitLicenseModel
- License model information for the restored DB instance. Default: Same as source. Valid values:license-included
|bring-your-own-license
|general-public-license
rditpitAvailabilityZone
- The EC2 Availability Zone that the database instance is created in. Default: A random, system-chosen Availability Zone. Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true. Example:us-east-1a
rditpitMultiAZ
- Specifies if the DB instance is a Multi-AZ deployment. Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set totrue
.rditpitOptionGroupName
- The name of the option group to be used for the restored DB instance. Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instancerditpitCopyTagsToSnapshot
- True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.rditpitTDECredentialARN
- The ARN from the Key Store with which to associate the instance for TDE encryption.rditpitDomainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the Directory Service.rditpitTags
- Undocumented member.rditpitPort
- The port number on which the database accepts connections. Constraints: Value must be1150-65535
Default: The same port as the original DB instance.rditpitEnableIAMDatabaseAuthentication
- True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false. You can enable IAM database authentication for the following database engines * For MySQL 5.6, minor version 5.6.34 or higher * For MySQL 5.7, minor version 5.7.16 or higher * Aurora 5.6 or higher. Default:false
rditpitStorageType
- Specifies the storage type to be associated with the DB instance. Valid values:standard | gp2 | io1
If you specifyio1
, you must also include a value for theIops
parameter. Default:io1
if theIops
parameter is specified; otherwisestandard
rditpitDBName
- The database name for the restored DB instance.rditpitSourceDBInstanceIdentifier
- The identifier of the source DB instance from which to restore. Constraints: * Must match the identifier of an existing DBInstance.rditpitTargetDBInstanceIdentifier
- The name of the new database instance to be created. 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
data RestoreDBInstanceToPointInTime Source #
See: restoreDBInstanceToPointInTime
smart constructor.
Request Lenses
rditpitUseLatestRestorableTime :: Lens' RestoreDBInstanceToPointInTime (Maybe Bool) Source #
Specifies whether (true
) or not (false
) the DB instance is restored from the latest backup time. Default: false
Constraints: Cannot be specified if RestoreTime parameter is provided.
rditpitPubliclyAccessible :: Lens' RestoreDBInstanceToPointInTime (Maybe Bool) Source #
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. Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case. * Default VPC: true * VPC: false If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
rditpitAutoMinorVersionUpgrade :: Lens' RestoreDBInstanceToPointInTime (Maybe Bool) Source #
Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
rditpitDBSubnetGroupName :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #
The DB subnet group name to use for the new instance. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup
rditpitRestoreTime :: Lens' RestoreDBInstanceToPointInTime (Maybe UTCTime) Source #
The date and time to restore from. Valid Values: Value must be a time in Universal Coordinated Time (UTC) format Constraints: * Must be before the latest restorable time for the DB instance * Cannot be specified if UseLatestRestorableTime parameter is true Example: 2009-09-07T23:45:00Z
rditpitIOPS :: Lens' RestoreDBInstanceToPointInTime (Maybe Int) Source #
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. Constraints: Must be an integer greater than 1000. SQL Server Setting the IOPS value for the SQL Server database engine is not supported.
rditpitDomain :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #
Specify the Active Directory Domain to restore the instance in.
rditpitEngine :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #
The database engine to use for the new instance. Default: The same as source Constraint: Must be compatible with the engine of the source Valid Values: * aurora
* mariadb
* mysql
* oracle-ee
* oracle-se2
* oracle-se1
* oracle-se
* postgres
* sqlserver-ee
* sqlserver-se
* sqlserver-ex
* sqlserver-web
rditpitTDECredentialPassword :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #
The password for the given ARN from the Key Store in order to access the device.
rditpitDBInstanceClass :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #
The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large
. Not all DB instance classes are available in all regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Default: The same DBInstanceClass as the original DB instance.
rditpitLicenseModel :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #
License model information for the restored DB instance. Default: Same as source. Valid values: license-included
| bring-your-own-license
| general-public-license
rditpitAvailabilityZone :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #
The EC2 Availability Zone that the database instance is created in. Default: A random, system-chosen Availability Zone. Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true. Example: us-east-1a
rditpitMultiAZ :: Lens' RestoreDBInstanceToPointInTime (Maybe Bool) Source #
Specifies if the DB instance is a Multi-AZ deployment. Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true
.
rditpitOptionGroupName :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #
The name of the option group to be used for the restored DB instance. Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
rditpitCopyTagsToSnapshot :: Lens' RestoreDBInstanceToPointInTime (Maybe Bool) Source #
True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.
rditpitTDECredentialARN :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #
The ARN from the Key Store with which to associate the instance for TDE encryption.
rditpitDomainIAMRoleName :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #
Specify the name of the IAM role to be used when making API calls to the Directory Service.
rditpitTags :: Lens' RestoreDBInstanceToPointInTime [Tag] Source #
Undocumented member.
rditpitPort :: Lens' RestoreDBInstanceToPointInTime (Maybe Int) Source #
The port number on which the database accepts connections. Constraints: Value must be 1150-65535
Default: The same port as the original DB instance.
rditpitEnableIAMDatabaseAuthentication :: Lens' RestoreDBInstanceToPointInTime (Maybe Bool) Source #
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false. You can enable IAM database authentication for the following database engines * For MySQL 5.6, minor version 5.6.34 or higher * For MySQL 5.7, minor version 5.7.16 or higher * Aurora 5.6 or higher. Default: false
rditpitStorageType :: Lens' RestoreDBInstanceToPointInTime (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
rditpitDBName :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) Source #
The database name for the restored DB instance.
rditpitSourceDBInstanceIdentifier :: Lens' RestoreDBInstanceToPointInTime Text Source #
The identifier of the source DB instance from which to restore. Constraints: * Must match the identifier of an existing DBInstance.
rditpitTargetDBInstanceIdentifier :: Lens' RestoreDBInstanceToPointInTime Text Source #
The name of the new database instance to be created. 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
Destructuring the Response
restoreDBInstanceToPointInTimeResponse Source #
Creates a value of RestoreDBInstanceToPointInTimeResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rditpitrsDBInstance
- Undocumented member.rditpitrsResponseStatus
- -- | The response status code.
data RestoreDBInstanceToPointInTimeResponse Source #
See: restoreDBInstanceToPointInTimeResponse
smart constructor.
Response Lenses
rditpitrsDBInstance :: Lens' RestoreDBInstanceToPointInTimeResponse (Maybe DBInstance) Source #
Undocumented member.
rditpitrsResponseStatus :: Lens' RestoreDBInstanceToPointInTimeResponse Int Source #
- - | The response status code.