Restore From Snapshot
redshiftserverless_restore_from_snapshot | R Documentation |
Restores a namespace from a snapshot¶
Description¶
Restores a namespace from a snapshot.
Usage¶
redshiftserverless_restore_from_snapshot(adminPasswordSecretKmsKeyId,
manageAdminPassword, namespaceName, ownerAccount, snapshotArn,
snapshotName, workgroupName)
Arguments¶
adminPasswordSecretKmsKeyId
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
manageAdminPassword
If
true
, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials. IfMmanageAdminPassword
is false or not set, Amazon Redshift uses the admin credentials that the namespace or cluster had at the time the snapshot was taken.namespaceName
[required] The name of the namespace to restore the snapshot to.
ownerAccount
The Amazon Web Services account that owns the snapshot.
snapshotArn
The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from Amazon Redshift Serverless to a provisioned cluster. Must not be specified at the same time as
snapshotName
.The format of the ARN is arn:aws:redshift:\<region\>:\<account_id\>:snapshot:\<cluster_identifier\>/\<snapshot_identifier\>.
snapshotName
The name of the snapshot to restore from. Must not be specified at the same time as
snapshotArn
.workgroupName
[required] The name of the workgroup used to restore the snapshot.
Value¶
A list with the following syntax:
list(
namespace = list(
adminPasswordSecretArn = "string",
adminPasswordSecretKmsKeyId = "string",
adminUsername = "string",
creationDate = as.POSIXct(
"2015-01-01"
),
dbName = "string",
defaultIamRoleArn = "string",
iamRoles = list(
"string"
),
kmsKeyId = "string",
logExports = list(
"useractivitylog"|"userlog"|"connectionlog"
),
namespaceArn = "string",
namespaceId = "string",
namespaceName = "string",
status = "AVAILABLE"|"MODIFYING"|"DELETING"
),
ownerAccount = "string",
snapshotName = "string"
)