# AlertingSilence

> Resource AlertingSilence in pulumi-portainer.

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

Resource AlertingSilence in pulumi-portainer.

Pulumi type: `portainer:index/alertingSilence:AlertingSilence`.

`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.AlertingSilence("alertingSilence", {
  alertManagerUrl: "<alertManagerUrl>",
  comment: "<comment>",
  createdBy: "<createdBy>",
  endsAt: "<endsAt>",
  matchers: [
    {
      isRegex: true,
      name: "<name>",
      value: "<value>",
    },
  ],
  startsAt: "<startsAt>",
})
```

## Arguments

| Property            | Type                               | Required | Description                                              |
| ------------------- | ---------------------------------- | -------- | -------------------------------------------------------- |
| `alertManagerUrl`   | `string`                           | yes      | URL of the AlertManager instance.                        |
| `alertingSilenceId` | `string`                           | no       |                                                          |
| `comment`           | `string`                           | yes      | Comment explaining the reason for the silence.           |
| `createdBy`         | `string`                           | yes      | Name of the user creating the silence.                   |
| `endsAt`            | `string`                           | yes      | End time of the silence in RFC3339 format.               |
| `matchers`          | `AlertingSilenceMatcher (input)[]` | yes      | List of matchers to determine which alerts are silenced. |
| `startsAt`          | `string`                           | yes      | Start time of the silence in RFC3339 format.             |

## Outputs

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

| Property            | Type                                | Computed | Description                                              |
| ------------------- | ----------------------------------- | -------- | -------------------------------------------------------- |
| `alertManagerUrl`   | `string`                            | no       | URL of the AlertManager instance.                        |
| `alertingSilenceId` | `string`                            | no       |                                                          |
| `comment`           | `string`                            | no       | Comment explaining the reason for the silence.           |
| `createdBy`         | `string`                            | no       | Name of the user creating the silence.                   |
| `endsAt`            | `string`                            | no       | End time of the silence in RFC3339 format.               |
| `matchers`          | `AlertingSilenceMatcher (output)[]` | no       | List of matchers to determine which alerts are silenced. |
| `startsAt`          | `string`                            | no       | Start time of the silence in RFC3339 format.             |

## `AlertingSilenceMatcher (input)`

Input object `AlertingSilenceMatcher`. Fields below belong to this object, not to the parent.

| Property  | Type      | Required | Description                                                 |
| --------- | --------- | -------- | ----------------------------------------------------------- |
| `isEqual` | `boolean` | no       | Whether to match for equality (true) or inequality (false). |
| `isRegex` | `boolean` | yes      | Whether the value is a regular expression.                  |
| `name`    | `string`  | yes      | Label name to match.                                        |
| `value`   | `string`  | yes      | Label value to match.                                       |

## `AlertingSilenceMatcher (output)`

Output object `AlertingSilenceMatcher`. Fields below belong to this object.

| Property  | Type      | Always present | Description                                                 |
| --------- | --------- | -------------- | ----------------------------------------------------------- |
| `isEqual` | `boolean` | no             | Whether to match for equality (true) or inequality (false). |
| `isRegex` | `boolean` | yes            | Whether the value is a regular expression.                  |
| `name`    | `string`  | yes            | Label name to match.                                        |
| `value`   | `string`  | yes            | Label value to match.                                       |