Restore Db Cluster To Point In Time
neptune_restore_db_cluster_to_point_in_time | R Documentation |
Restores a DB cluster to an arbitrary point in time¶
Description¶
Restores a DB cluster to an arbitrary point in time. Users can restore
to any point in time before LatestRestorableTime
for up to
BackupRetentionPeriod
days. The target DB cluster is created from the
source DB cluster with the same configuration as the original DB
cluster, except that the new DB cluster is created with the default DB
security group.
This action only restores the DB cluster, not the DB instances for that
DB cluster. You must invoke the create_db_instance
action to create DB
instances for the restored DB cluster, specifying the identifier of the
restored DB cluster in DBClusterIdentifier
. You can create DB
instances only after the restore_db_cluster_to_point_in_time
action
has completed and the DB cluster is available.
Usage¶
neptune_restore_db_cluster_to_point_in_time(DBClusterIdentifier,
RestoreType, SourceDBClusterIdentifier, RestoreToTime,
UseLatestRestorableTime, Port, DBSubnetGroupName, OptionGroupName,
VpcSecurityGroupIds, Tags, KmsKeyId, EnableIAMDatabaseAuthentication,
EnableCloudwatchLogsExports, DBClusterParameterGroupName,
DeletionProtection, ServerlessV2ScalingConfiguration, StorageType)
Arguments¶
DBClusterIdentifier
[required] The name of the new DB cluster 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
RestoreType
The type of restore to be performed. You can specify one of the following values:
full-copy
- The new DB cluster is restored as a full copy of the source DB cluster.copy-on-write
- The new DB cluster is restored as a clone of the source DB cluster.
If you don't specify a
RestoreType
value, then the new DB cluster is restored as a full copy of the source DB cluster.SourceDBClusterIdentifier
[required] The identifier of the source DB cluster from which to restore.
Constraints:
Must match the identifier of an existing DBCluster.
RestoreToTime
The date and time to restore the DB cluster to.
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
Must be specified if
UseLatestRestorableTime
parameter is not providedCannot be specified if
UseLatestRestorableTime
parameter is trueCannot be specified if
RestoreType
parameter iscopy-on-write
Example:
2015-03-07T23:45:00Z
UseLatestRestorableTime
A value that is set to
true
to restore the DB cluster to the latest restorable backup time, andfalse
otherwise.Default:
false
Constraints: Cannot be specified if
RestoreToTime
parameter is provided.Port
The port number on which the new DB cluster accepts connections.
Constraints: Value must be
1150-65535
Default: The same port as the original DB cluster.
DBSubnetGroupName
The DB subnet group name to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example:
mySubnetgroup
OptionGroupName
(Not supported by Neptune)
VpcSecurityGroupIds
A list of VPC security groups that the new DB cluster belongs to.
Tags
The tags to be applied to the restored DB cluster.
KmsKeyId
The Amazon KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same Amazon account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the
KmsKeyId
parameter.If you do not specify a value for the
KmsKeyId
parameter, then the following will occur:If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.
If
DBClusterIdentifier
refers to a DB cluster that is not encrypted, then the restore request is rejected.EnableIAMDatabaseAuthentication
True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default:
false
EnableCloudwatchLogsExports
The list of logs that the restored DB cluster is to export to CloudWatch Logs.
DBClusterParameterGroupName
The name of the DB cluster parameter group to associate with the new DB cluster.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
DeletionProtection
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
ServerlessV2ScalingConfiguration
Contains the scaling configuration of a Neptune Serverless DB cluster.
For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.
StorageType
Specifies the storage type to be associated with the DB cluster.
Valid values:
standard
,iopt1
Default:
standard
Value¶
A list with the following syntax:
list(
DBCluster = list(
AllocatedStorage = 123,
AvailabilityZones = list(
"string"
),
BackupRetentionPeriod = 123,
CharacterSetName = "string",
DatabaseName = "string",
DBClusterIdentifier = "string",
DBClusterParameterGroup = "string",
DBSubnetGroup = "string",
Status = "string",
PercentProgress = "string",
EarliestRestorableTime = as.POSIXct(
"2015-01-01"
),
Endpoint = "string",
ReaderEndpoint = "string",
MultiAZ = TRUE|FALSE,
Engine = "string",
EngineVersion = "string",
LatestRestorableTime = as.POSIXct(
"2015-01-01"
),
Port = 123,
MasterUsername = "string",
DBClusterOptionGroupMemberships = list(
list(
DBClusterOptionGroupName = "string",
Status = "string"
)
),
PreferredBackupWindow = "string",
PreferredMaintenanceWindow = "string",
ReplicationSourceIdentifier = "string",
ReadReplicaIdentifiers = list(
"string"
),
DBClusterMembers = list(
list(
DBInstanceIdentifier = "string",
IsClusterWriter = TRUE|FALSE,
DBClusterParameterGroupStatus = "string",
PromotionTier = 123
)
),
VpcSecurityGroups = list(
list(
VpcSecurityGroupId = "string",
Status = "string"
)
),
HostedZoneId = "string",
StorageEncrypted = TRUE|FALSE,
KmsKeyId = "string",
DbClusterResourceId = "string",
DBClusterArn = "string",
AssociatedRoles = list(
list(
RoleArn = "string",
Status = "string",
FeatureName = "string"
)
),
IAMDatabaseAuthenticationEnabled = TRUE|FALSE,
CloneGroupId = "string",
ClusterCreateTime = as.POSIXct(
"2015-01-01"
),
CopyTagsToSnapshot = TRUE|FALSE,
EnabledCloudwatchLogsExports = list(
"string"
),
PendingModifiedValues = list(
PendingCloudwatchLogsExports = list(
LogTypesToEnable = list(
"string"
),
LogTypesToDisable = list(
"string"
)
),
DBClusterIdentifier = "string",
IAMDatabaseAuthenticationEnabled = TRUE|FALSE,
EngineVersion = "string",
BackupRetentionPeriod = 123,
StorageType = "string",
AllocatedStorage = 123,
Iops = 123
),
DeletionProtection = TRUE|FALSE,
CrossAccountClone = TRUE|FALSE,
AutomaticRestartTime = as.POSIXct(
"2015-01-01"
),
ServerlessV2ScalingConfiguration = list(
MinCapacity = 123.0,
MaxCapacity = 123.0
),
GlobalClusterIdentifier = "string",
IOOptimizedNextAllowedModificationTime = as.POSIXct(
"2015-01-01"
),
StorageType = "string"
)
)
Request syntax¶
svc$restore_db_cluster_to_point_in_time(
DBClusterIdentifier = "string",
RestoreType = "string",
SourceDBClusterIdentifier = "string",
RestoreToTime = as.POSIXct(
"2015-01-01"
),
UseLatestRestorableTime = TRUE|FALSE,
Port = 123,
DBSubnetGroupName = "string",
OptionGroupName = "string",
VpcSecurityGroupIds = list(
"string"
),
Tags = list(
list(
Key = "string",
Value = "string"
)
),
KmsKeyId = "string",
EnableIAMDatabaseAuthentication = TRUE|FALSE,
EnableCloudwatchLogsExports = list(
"string"
),
DBClusterParameterGroupName = "string",
DeletionProtection = TRUE|FALSE,
ServerlessV2ScalingConfiguration = list(
MinCapacity = 123.0,
MaxCapacity = 123.0
),
StorageType = "string"
)