Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
docdb_restore_db_cluster_from_snapshot(AvailabilityZones,
DBClusterIdentifier, SnapshotIdentifier, Engine, EngineVersion, Port,
DBSubnetGroupName, VpcSecurityGroupIds, Tags, KmsKeyId,
EnableCloudwatchLogsExports, DeletionProtection)
Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.
[required] The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn\'t case sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-snapshot-id
[required] The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
Must match the identifier of an existing snapshot.
[required] The database engine to use for the new DB cluster.
Default: The same as source.
Constraint: Must be compatible with the engine of the source.
The version of the database engine to use for the new DB cluster.
The port number on which the new DB cluster accepts connections.
Constraints: Must be a value from 1150
to 65535
.
Default: The same port as the original DB cluster.
The name of the DB subnet group to use for the new DB cluster.
Constraints: If provided, must match the name of an existing
DBSubnetGroup
.
Example: mySubnetgroup
A list of virtual private cloud (VPC) security groups that the new DB cluster will belong to.
The tags to be assigned to the restored DB cluster.
The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new DB cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.
If you do not specify a value for the KmsKeyId
parameter, then the
following occurs:
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier
is
encrypted, then the restored DB cluster is encrypted using the AWS
KMS key that was used to encrypt the DB snapshot or the DB cluster
snapshot.
If the DB snapshot or the DB cluster snapshot in
SnapshotIdentifier
is not encrypted, then the restored DB cluster
is not encrypted.
A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
Specifies whether this cluster can be deleted. If DeletionProtection
is enabled, the cluster cannot be deleted unless it is modified and
DeletionProtection
is disabled. DeletionProtection
protects clusters
from being accidentally deleted.
svc$restore_db_cluster_from_snapshot( AvailabilityZones = list( "string" ), DBClusterIdentifier = "string", SnapshotIdentifier = "string", Engine = "string", EngineVersion = "string", Port = 123, DBSubnetGroupName = "string", VpcSecurityGroupIds = list( "string" ), Tags = list( list( Key = "string", Value = "string" ) ), KmsKeyId = "string", EnableCloudwatchLogsExports = list( "string" ), DeletionProtection = TRUE|FALSE )
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.