Skip to main content

Restore

Resource Restore in pulumi-portainer.
2 min read

Resource Restore in pulumi-portainer.

Pulumi type: portainer:index/restore:Restore.

name is the Pulumi resource name. Nested object fields are documented under that object. They are not arguments of this resource.

Example#

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

Arguments#

PropertyTypeRequiredDescription
fileContentBase64stringyesBase64-encoded content of the backup archive, typically filebase64("portainer-backup.tar.gz"). A backup contains every credential Portainer holds, so it is stored in state as a sensitive value.
fileNamestringnoName reported to Portainer for the uploaded archive.
passwordstringnoPassword the backup was encrypted with. Leave unset for an unencrypted backup.
restoreIdstringno
setupTokenstringnoValue sent as the X-Setup-Token header. Portainer requires it when the instance has not been initialised yet, which is the usual state for a restore.

Outputs#

Computed outputs are produced by the provider. They are not constructor arguments.

PropertyTypeComputedDescription
fileContentBase64stringnoBase64-encoded content of the backup archive, typically filebase64("portainer-backup.tar.gz"). A backup contains every credential Portainer holds, so it is stored in state as a sensitive value.
fileNamestringnoName reported to Portainer for the uploaded archive.
passwordstringnoPassword the backup was encrypted with. Leave unset for an unencrypted backup.
restoreIdstringno
setupTokenstringnoValue sent as the X-Setup-Token header. Portainer requires it when the instance has not been initialised yet, which is the usual state for a restore.