db Snapshot Identifier
The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the `DBSnapshotIdentifier`
property is an empty string or the `AWS::RDS::DBInstance`
declaration has no `DBSnapshotIdentifier`
property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as the `MasterUsername`
and `MasterUserPassword`
properties. For information about the properties that you can specify, see the `RestoreDBInstanceFromDBSnapshot`
action in the Amazon RDS API Reference. After you restore a DB instance with a `DBSnapshotIdentifier`
property, you must specify the same `DBSnapshotIdentifier`
property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the `DBSnapshotIdentifier`
property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified `DBSnapshotIdentifier`
property, and the original DB instance is deleted. If you specify the `DBSnapshotIdentifier`
property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties:
`CharacterSetName`
`DBClusterIdentifier`
`DBName`
`DeleteAutomatedBackups`
`KmsKeyId`
`MasterUsername`
`MasterUserPassword`
`PerformanceInsightsKMSKeyId`
`PerformanceInsightsRetentionPeriod`
`PromotionTier`
`SourceDBInstanceIdentifier`
`SourceRegion`
`StorageEncrypted`
(for an encrypted snapshot)`Timezone`
Amazon Aurora Not applicable. Snapshot restore is managed by the DB cluster.