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 |
Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security 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 AZ deployment and not a single-AZ deployment.
If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier
must be the ARN of the shared DB snapshot.
- restoreDBInstanceFromDBSnapshot :: Text -> Text -> RestoreDBInstanceFromDBSnapshot
- data RestoreDBInstanceFromDBSnapshot
- rdifdsPubliclyAccessible :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Bool)
- rdifdsAutoMinorVersionUpgrade :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Bool)
- rdifdsDBSubnetGroupName :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text)
- rdifdsIOPS :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Int)
- rdifdsDomain :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text)
- rdifdsEngine :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text)
- rdifdsTDECredentialPassword :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text)
- rdifdsDBInstanceClass :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text)
- rdifdsLicenseModel :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text)
- rdifdsAvailabilityZone :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text)
- rdifdsMultiAZ :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Bool)
- rdifdsOptionGroupName :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text)
- rdifdsCopyTagsToSnapshot :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Bool)
- rdifdsTDECredentialARN :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text)
- rdifdsDomainIAMRoleName :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text)
- rdifdsTags :: Lens' RestoreDBInstanceFromDBSnapshot [Tag]
- rdifdsPort :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Int)
- rdifdsEnableIAMDatabaseAuthentication :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Bool)
- rdifdsStorageType :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text)
- rdifdsEnableCloudwatchLogsExports :: Lens' RestoreDBInstanceFromDBSnapshot [Text]
- rdifdsDBName :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text)
- rdifdsDBInstanceIdentifier :: Lens' RestoreDBInstanceFromDBSnapshot Text
- rdifdsDBSnapshotIdentifier :: Lens' RestoreDBInstanceFromDBSnapshot Text
- restoreDBInstanceFromDBSnapshotResponse :: Int -> RestoreDBInstanceFromDBSnapshotResponse
- data RestoreDBInstanceFromDBSnapshotResponse
- rdifdsrsDBInstance :: Lens' RestoreDBInstanceFromDBSnapshotResponse (Maybe DBInstance)
- rdifdsrsResponseStatus :: Lens' RestoreDBInstanceFromDBSnapshotResponse Int
Creating a Request
restoreDBInstanceFromDBSnapshot Source #
Creates a value of RestoreDBInstanceFromDBSnapshot
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rdifdsPubliclyAccessible
- 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.rdifdsAutoMinorVersionUpgrade
- Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.rdifdsDBSubnetGroupName
- The DB subnet group name to use for the new instance. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example:mySubnetgroup
rdifdsIOPS
- Specifies the amount of provisioned IOPS for the DB instance, expressed in IO operations per second. If this parameter is not specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts. The provisioned IOPS value must follow the requirements for your database engine. For more information, see <http:docs.aws.amazon.comAmazonRDSlatestUserGuide/CHAP_Storage.html#USER_PIOPS Amazon RDS Provisioned IOPS Storage to Improve Performance> . Constraints: Must be an integer greater than 1000.rdifdsDomain
- Specify the Active Directory Domain to restore the instance in.rdifdsEngine
- The database engine to use for the new instance. Default: The same as source Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot. Valid Values: *mariadb
*mysql
*oracle-ee
*oracle-se2
*oracle-se1
*oracle-se
*postgres
*sqlserver-ee
*sqlserver-se
*sqlserver-ex
*sqlserver-web
rdifdsTDECredentialPassword
- The password for the given ARN from the key store in order to access the device.rdifdsDBInstanceClass
- The compute and memory capacity of the Amazon RDS DB instance, for example,db.m4.large
. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Default: The same DBInstanceClass as the original DB instance.rdifdsLicenseModel
- License model information for the restored DB instance. Default: Same as source. Valid values:license-included
|bring-your-own-license
|general-public-license
rdifdsAvailabilityZone
- The EC2 Availability Zone that the DB instance is created in. Default: A random, system-chosen Availability Zone. Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set totrue
. Example:us-east-1a
rdifdsMultiAZ
- Specifies if the DB instance is a Multi-AZ deployment. Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set totrue
.rdifdsOptionGroupName
- The name of the option group to be used for the restored DB instance. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instancerdifdsCopyTagsToSnapshot
- True to copy all tags from the restored DB instance to snapshots of the DB instance, and otherwise false. The default is false.rdifdsTDECredentialARN
- The ARN from the key store with which to associate the instance for TDE encryption.rdifdsDomainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the Directory Service.rdifdsTags
- Undocumented member.rdifdsPort
- The port number on which the database accepts connections. Default: The same port as the original DB instance Constraints: Value must be1150-65535
rdifdsEnableIAMDatabaseAuthentication
- True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and 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 Default:false
rdifdsStorageType
- 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
rdifdsEnableCloudwatchLogsExports
- The list of logs that the restored DB instance is to export to CloudWatch Logs.rdifdsDBName
- The database name for the restored DB instance.rdifdsDBInstanceIdentifier
- Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive. Constraints: * Must contain from 1 to 63 numbers, letters, or hyphens * First character must be a letter * Cannot end with a hyphen or contain two consecutive hyphens Example:my-snapshot-id
rdifdsDBSnapshotIdentifier
- The identifier for the DB snapshot to restore from. Constraints: * Must match the identifier of an existing DBSnapshot. * If you are restoring from a shared manual DB snapshot, theDBSnapshotIdentifier
must be the ARN of the shared DB snapshot.
data RestoreDBInstanceFromDBSnapshot Source #
See: restoreDBInstanceFromDBSnapshot
smart constructor.
Request Lenses
rdifdsPubliclyAccessible :: Lens' RestoreDBInstanceFromDBSnapshot (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.
rdifdsAutoMinorVersionUpgrade :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Bool) Source #
Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
rdifdsDBSubnetGroupName :: Lens' RestoreDBInstanceFromDBSnapshot (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
rdifdsIOPS :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Int) Source #
Specifies the amount of provisioned IOPS for the DB instance, expressed in IO operations per second. If this parameter is not specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts. The provisioned IOPS value must follow the requirements for your database engine. For more information, see <http:docs.aws.amazon.comAmazonRDSlatestUserGuide/CHAP_Storage.html#USER_PIOPS Amazon RDS Provisioned IOPS Storage to Improve Performance> . Constraints: Must be an integer greater than 1000.
rdifdsDomain :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) Source #
Specify the Active Directory Domain to restore the instance in.
rdifdsEngine :: Lens' RestoreDBInstanceFromDBSnapshot (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. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot. Valid Values: * mariadb
* mysql
* oracle-ee
* oracle-se2
* oracle-se1
* oracle-se
* postgres
* sqlserver-ee
* sqlserver-se
* sqlserver-ex
* sqlserver-web
rdifdsTDECredentialPassword :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) Source #
The password for the given ARN from the key store in order to access the device.
rdifdsDBInstanceClass :: Lens' RestoreDBInstanceFromDBSnapshot (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 AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Default: The same DBInstanceClass as the original DB instance.
rdifdsLicenseModel :: Lens' RestoreDBInstanceFromDBSnapshot (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
rdifdsAvailabilityZone :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) Source #
The EC2 Availability Zone that the DB instance is created in. Default: A random, system-chosen Availability Zone. Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set to true
. Example: us-east-1a
rdifdsMultiAZ :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Bool) Source #
Specifies if the DB instance is a Multi-AZ deployment. Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set to true
.
rdifdsOptionGroupName :: Lens' RestoreDBInstanceFromDBSnapshot (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, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
rdifdsCopyTagsToSnapshot :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Bool) Source #
True to copy all tags from the restored DB instance to snapshots of the DB instance, and otherwise false. The default is false.
rdifdsTDECredentialARN :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) Source #
The ARN from the key store with which to associate the instance for TDE encryption.
rdifdsDomainIAMRoleName :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) Source #
Specify the name of the IAM role to be used when making API calls to the Directory Service.
rdifdsTags :: Lens' RestoreDBInstanceFromDBSnapshot [Tag] Source #
Undocumented member.
rdifdsPort :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Int) Source #
The port number on which the database accepts connections. Default: The same port as the original DB instance Constraints: Value must be 1150-65535
rdifdsEnableIAMDatabaseAuthentication :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Bool) Source #
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and 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 Default: false
rdifdsStorageType :: Lens' RestoreDBInstanceFromDBSnapshot (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
rdifdsEnableCloudwatchLogsExports :: Lens' RestoreDBInstanceFromDBSnapshot [Text] Source #
The list of logs that the restored DB instance is to export to CloudWatch Logs.
rdifdsDBName :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) Source #
The database name for the restored DB instance.
rdifdsDBInstanceIdentifier :: Lens' RestoreDBInstanceFromDBSnapshot Text Source #
Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive. Constraints: * Must contain from 1 to 63 numbers, letters, or hyphens * First character must be a letter * Cannot end with a hyphen or contain two consecutive hyphens Example: my-snapshot-id
rdifdsDBSnapshotIdentifier :: Lens' RestoreDBInstanceFromDBSnapshot Text Source #
The identifier for the DB snapshot to restore from. Constraints: * Must match the identifier of an existing DBSnapshot. * If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier
must be the ARN of the shared DB snapshot.
Destructuring the Response
restoreDBInstanceFromDBSnapshotResponse Source #
Creates a value of RestoreDBInstanceFromDBSnapshotResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rdifdsrsDBInstance
- Undocumented member.rdifdsrsResponseStatus
- -- | The response status code.
data RestoreDBInstanceFromDBSnapshotResponse Source #
See: restoreDBInstanceFromDBSnapshotResponse
smart constructor.
Response Lenses
rdifdsrsDBInstance :: Lens' RestoreDBInstanceFromDBSnapshotResponse (Maybe DBInstance) Source #
Undocumented member.
rdifdsrsResponseStatus :: Lens' RestoreDBInstanceFromDBSnapshotResponse Int Source #
- - | The response status code.