mirror of
https://github.com/Kichiyaki/terraform-provider-woodpecker.git
synced 2024-07-05 18:47:38 +00:00
49 lines
1.5 KiB
Markdown
49 lines
1.5 KiB
Markdown
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "woodpecker_secret Resource - terraform-provider-woodpecker"
|
|
subcategory: ""
|
|
description: |-
|
|
This resource allows you to add/remove global secrets. When applied, a new secret will be created. When destroyed, that secret will be removed. For more information see the Woodpecker docs https://woodpecker-ci.org/docs/usage/secrets.
|
|
---
|
|
|
|
# woodpecker_secret (Resource)
|
|
|
|
This resource allows you to add/remove global secrets. When applied, a new secret will be created. When destroyed, that secret will be removed. For more information see [the Woodpecker docs](https://woodpecker-ci.org/docs/usage/secrets).
|
|
|
|
## Example Usage
|
|
|
|
```terraform
|
|
# Create a secret
|
|
resource "woodpecker_secret" "test" {
|
|
name = "test"
|
|
value = "test"
|
|
events = ["cron", "deployment"]
|
|
}
|
|
```
|
|
|
|
<!-- schema generated by tfplugindocs -->
|
|
## Schema
|
|
|
|
### Required
|
|
|
|
- `events` (Set of String) events for which the secret is available (push, tag, pull_request, deployment, cron, manual)
|
|
- `name` (String) the name of the secret
|
|
- `value` (String, Sensitive) the value of the secret
|
|
|
|
### Optional
|
|
|
|
- `images` (Set of String) list of Docker images for which this secret is available, leave blank to allow all images
|
|
- `plugins_only` (Boolean) whether secret is only available for [plugins](https://woodpecker-ci.org/docs/usage/plugins/plugins)
|
|
|
|
### Read-Only
|
|
|
|
- `id` (Number) the secret's id
|
|
|
|
## Import
|
|
|
|
Import is supported using the following syntax:
|
|
|
|
```shell
|
|
terraform import woodpecker_secret.test "<name>"
|
|
```
|