Skip to content

/AWS1/CL_RSS=>RESTOREFROMSNAPSHOT()

About RestoreFromSnapshot

Restores a namespace from a snapshot.

Method Signature

IMPORTING

Required arguments:

IV_NAMESPACENAME TYPE /AWS1/RSSNAMESPACENAME /AWS1/RSSNAMESPACENAME

The name of the namespace to restore the snapshot to.

IV_WORKGROUPNAME TYPE /AWS1/RSSWORKGROUPNAME /AWS1/RSSWORKGROUPNAME

The name of the workgroup used to restore the snapshot.

Optional arguments:

IV_SNAPSHOTNAME TYPE /AWS1/RSSSTRING /AWS1/RSSSTRING

The name of the snapshot to restore from. Must not be specified at the same time as snapshotArn.

IV_SNAPSHOTARN TYPE /AWS1/RSSSTRING /AWS1/RSSSTRING

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>.

IV_OWNERACCOUNT TYPE /AWS1/RSSSTRING /AWS1/RSSSTRING

The Amazon Web Services account that owns the snapshot.

IV_MANAGEADMINPASSWORD TYPE /AWS1/RSSBOOLEAN /AWS1/RSSBOOLEAN

If true, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials. If MmanageAdminPassword is false or not set, Amazon Redshift uses the admin credentials that the namespace or cluster had at the time the snapshot was taken.

IV_ADMINPASSWORDSECRETKMSK00 TYPE /AWS1/RSSKMSKEYID /AWS1/RSSKMSKEYID

The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_RSSRESTOREFROMSNAPRSP /AWS1/CL_RSSRESTOREFROMSNAPRSP