# EdgeGroup

> Resource EdgeGroup in pulumi-portainer.

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

Resource EdgeGroup in pulumi-portainer.

Pulumi type: `portainer:index/edgeGroup:EdgeGroup`.

`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.EdgeGroup("edgeGroup", {
  dynamic: true,
})
```

## Arguments

| Property       | Type       | Required | Description                                                                                                              |
| -------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
| `dynamic`      | `boolean`  | yes      | Whether the Edge group is dynamic (membership determined by tags) or static (explicit endpoints).                        |
| `edgeGroupId`  | `string`   | no       |                                                                                                                          |
| `endpoints`    | `number[]` | no       | List of Portainer environment (endpoint) IDs that are statically assigned to the Edge group. Used when dynamic is false. |
| `name`         | `string`   | no       | Name of the Portainer Edge group.                                                                                        |
| `partialMatch` | `boolean`  | no       | For dynamic groups, whether to match endpoints with any (true) or all (false) of the specified tags.                     |
| `tagIds`       | `number[]` | no       | List of tag IDs used to dynamically select endpoints. Used when dynamic is true.                                         |

## Outputs

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

| Property       | Type       | Computed | Description                                                                                                              |
| -------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
| `dynamic`      | `boolean`  | no       | Whether the Edge group is dynamic (membership determined by tags) or static (explicit endpoints).                        |
| `edgeGroupId`  | `string`   | no       |                                                                                                                          |
| `endpoints`    | `number[]` | no       | List of Portainer environment (endpoint) IDs that are statically assigned to the Edge group. Used when dynamic is false. |
| `name`         | `string`   | no       | Name of the Portainer Edge group.                                                                                        |
| `partialMatch` | `boolean`  | no       | For dynamic groups, whether to match endpoints with any (true) or all (false) of the specified tags.                     |
| `tagIds`       | `number[]` | no       | List of tag IDs used to dynamically select endpoints. Used when dynamic is true.                                         |