Skip to main content

EdgeGroup

Resource EdgeGroup in pulumi-portainer.
2 min read

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.

Arguments#

PropertyTypeRequiredDescription
dynamicbooleanyesWhether the Edge group is dynamic (membership determined by tags) or static (explicit endpoints).
edgeGroupIdstringno
endpointsnumber[]noList of Portainer environment (endpoint) IDs that are statically assigned to the Edge group. Used when dynamic is false.
namestringnoName of the Portainer Edge group.
partialMatchbooleannoFor dynamic groups, whether to match endpoints with any (true) or all (false) of the specified tags.
tagIdsnumber[]noList 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.

PropertyTypeComputedDescription
dynamicbooleannoWhether the Edge group is dynamic (membership determined by tags) or static (explicit endpoints).
edgeGroupIdstringno
endpointsnumber[]noList of Portainer environment (endpoint) IDs that are statically assigned to the Edge group. Used when dynamic is false.
namestringnoName of the Portainer Edge group.
partialMatchbooleannoFor dynamic groups, whether to match endpoints with any (true) or all (false) of the specified tags.
tagIdsnumber[]noList of tag IDs used to dynamically select endpoints. Used when dynamic is true.