# Backup

> Resource Backup in pulumi-portainer.

<!-- Generated from the pulumi-portainer SDK. -->

Resource Backup in pulumi-portainer.

Pulumi type: `portainer:index/backup:Backup`.

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

```ts
import * as portainer from "pulumi-portainer"

const resource = new portainer.Backup("backup", {
  outputPath: "<outputPath>",
  password: "<password>",
})
```

## Arguments

| Property     | Type     | Required | Description                                                      |
| ------------ | -------- | -------- | ---------------------------------------------------------------- |
| `backupId`   | `string` | no       |                                                                  |
| `outputPath` | `string` | yes      | Path on local disk where the backup .tar.gz should be saved      |
| `password`   | `string` | yes      | Sensitive password used to encrypt the Portainer backup archive. |

## Outputs

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

| Property     | Type     | Computed | Description                                                      |
| ------------ | -------- | -------- | ---------------------------------------------------------------- |
| `backupId`   | `string` | no       |                                                                  |
| `outputPath` | `string` | no       | Path on local disk where the backup .tar.gz should be saved      |
| `password`   | `string` | no       | Sensitive password used to encrypt the Portainer backup archive. |