Group

Unifi v0.3.0, Jul 8 26

Viewing docs for Unifi v0.3.0
published on Wednesday, Jul 8, 2026 by Pulumiverse

Schema (JSON)

pulumiverse/pulumi-unifi

Viewing docs for Unifi v0.3.0
published on Wednesday, Jul 8, 2026 by Pulumiverse

Schema (JSON)

pulumiverse/pulumi-unifi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as unifi from "@pulumiverse/unifi";

const example = new unifi.ap.Group("example", {
    name: "my-ap-group",
    deviceMacs: ["00:11:22:33:44:55"],
});

import pulumi
import pulumiverse_unifi as unifi

example = unifi.ap.Group("example",
    name="my-ap-group",
    device_macs=["00:11:22:33:44:55"])

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-unifi/sdk/go/unifi/ap"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ap.NewGroup(ctx, "example", &ap.GroupArgs{
			Name: pulumi.String("my-ap-group"),
			DeviceMacs: pulumi.StringArray{
				pulumi.String("00:11:22:33:44:55"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Unifi = Pulumiverse.Unifi;

return await Deployment.RunAsync(() => 
{
    var example = new Unifi.Ap.Group("example", new()
    {
        Name = "my-ap-group",
        DeviceMacs = new[]
        {
            "00:11:22:33:44:55",
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumiverse.unifi.ap.Group;
import com.pulumiverse.unifi.ap.GroupArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Group("example", GroupArgs.builder()
            .name("my-ap-group")
            .deviceMacs("00:11:22:33:44:55")
            .build());

    }
}

resources:
  example:
    type: unifi:ap:Group
    properties:
      name: my-ap-group
      deviceMacs:
        - 00:11:22:33:44:55

pulumi {
  required_providers {
    unifi = {
      source = "pulumi/unifi"
    }
  }
}

resource "unifi_ap_group" "example" {
  name        = "my-ap-group"
  device_macs = ["00:11:22:33:44:55"]
}

Create Group Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);

@overload
def Group(resource_name: str,
          args: GroupArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          device_macs: Optional[Sequence[str]] = None,
          name: Optional[str] = None,
          site: Optional[str] = None)

func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)

public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)

public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)

type: unifi:ap:Group
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "unifi_ap_group" "name" {
    # resource properties
}

Parameters

name string: The unique name of the resource.
args GroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args GroupArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args GroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args GroupArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var groupResource = new Unifi.Ap.Group("groupResource", new()
{
    DeviceMacs = new[]
    {
        "string",
    },
    Name = "string",
    Site = "string",
});

example, err := ap.NewGroup(ctx, "groupResource", &ap.GroupArgs{
	DeviceMacs: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Site: pulumi.String("string"),
})

resource "unifi_ap_group" "groupResource" {
  device_macs = ["string"]
  name        = "string"
  site        = "string"
}

var groupResource = new com.pulumiverse.unifi.ap.Group("groupResource", com.pulumiverse.unifi.ap.GroupArgs.builder()
    .deviceMacs("string")
    .name("string")
    .site("string")
    .build());

group_resource = unifi.ap.Group("groupResource",
    device_macs=["string"],
    name="string",
    site="string")

const groupResource = new unifi.ap.Group("groupResource", {
    deviceMacs: ["string"],
    name: "string",
    site: "string",
});

type: unifi:ap:Group
properties:
    deviceMacs:
        - string
    name: string
    site: string

Group Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Group resource accepts the following input properties:

DeviceMacs List<string>: Set of AP device MAC addresses to include in this AP group. MAC addresses are case-insensitive and may use : or - separators (e.g. aa:bb:cc:dd:ee:ff and AA-BB-CC-DD-EE-FF are treated as the same address and produce no diff); the value is kept as written.
Name string: The name of the AP group.
Site string: The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.

DeviceMacs []string: Set of AP device MAC addresses to include in this AP group. MAC addresses are case-insensitive and may use : or - separators (e.g. aa:bb:cc:dd:ee:ff and AA-BB-CC-DD-EE-FF are treated as the same address and produce no diff); the value is kept as written.
Name string: The name of the AP group.
Site string: The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.

device_macs list(string): Set of AP device MAC addresses to include in this AP group. MAC addresses are case-insensitive and may use : or - separators (e.g. aa:bb:cc:dd:ee:ff and AA-BB-CC-DD-EE-FF are treated as the same address and produce no diff); the value is kept as written.
name string: The name of the AP group.
site string: The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.

deviceMacs List<String>: Set of AP device MAC addresses to include in this AP group. MAC addresses are case-insensitive and may use : or - separators (e.g. aa:bb:cc:dd:ee:ff and AA-BB-CC-DD-EE-FF are treated as the same address and produce no diff); the value is kept as written.
name String: The name of the AP group.
site String: The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.

deviceMacs string[]: Set of AP device MAC addresses to include in this AP group. MAC addresses are case-insensitive and may use : or - separators (e.g. aa:bb:cc:dd:ee:ff and AA-BB-CC-DD-EE-FF are treated as the same address and produce no diff); the value is kept as written.
name string: The name of the AP group.
site string: The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.

device_macs Sequence[str]: Set of AP device MAC addresses to include in this AP group. MAC addresses are case-insensitive and may use : or - separators (e.g. aa:bb:cc:dd:ee:ff and AA-BB-CC-DD-EE-FF are treated as the same address and produce no diff); the value is kept as written.
name str: The name of the AP group.
site str: The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.

deviceMacs List<String>: Set of AP device MAC addresses to include in this AP group. MAC addresses are case-insensitive and may use : or - separators (e.g. aa:bb:cc:dd:ee:ff and AA-BB-CC-DD-EE-FF are treated as the same address and produce no diff); the value is kept as written.
name String: The name of the AP group.
site String: The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.

Outputs

All input properties are implicitly available as output properties. Additionally, the Group resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing Group Resource

Get an existing Group resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: GroupState, opts?: CustomResourceOptions): Group

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        device_macs: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        site: Optional[str] = None) -> Group

func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)

public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)

public static Group get(String name, Output<String> id, GroupState state, CustomResourceOptions options)

resources:  _:    type: unifi:ap:Group    get:      id: ${id}

import {
  to = unifi_ap_group.example
  id = "${id}"
}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

DeviceMacs List<string>: Set of AP device MAC addresses to include in this AP group. MAC addresses are case-insensitive and may use : or - separators (e.g. aa:bb:cc:dd:ee:ff and AA-BB-CC-DD-EE-FF are treated as the same address and produce no diff); the value is kept as written.
Name string: The name of the AP group.
Site string: The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.

DeviceMacs []string: Set of AP device MAC addresses to include in this AP group. MAC addresses are case-insensitive and may use : or - separators (e.g. aa:bb:cc:dd:ee:ff and AA-BB-CC-DD-EE-FF are treated as the same address and produce no diff); the value is kept as written.
Name string: The name of the AP group.
Site string: The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.

device_macs list(string): Set of AP device MAC addresses to include in this AP group. MAC addresses are case-insensitive and may use : or - separators (e.g. aa:bb:cc:dd:ee:ff and AA-BB-CC-DD-EE-FF are treated as the same address and produce no diff); the value is kept as written.
name string: The name of the AP group.
site string: The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.

deviceMacs List<String>: Set of AP device MAC addresses to include in this AP group. MAC addresses are case-insensitive and may use : or - separators (e.g. aa:bb:cc:dd:ee:ff and AA-BB-CC-DD-EE-FF are treated as the same address and produce no diff); the value is kept as written.
name String: The name of the AP group.
site String: The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.

deviceMacs string[]: Set of AP device MAC addresses to include in this AP group. MAC addresses are case-insensitive and may use : or - separators (e.g. aa:bb:cc:dd:ee:ff and AA-BB-CC-DD-EE-FF are treated as the same address and produce no diff); the value is kept as written.
name string: The name of the AP group.
site string: The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.

device_macs Sequence[str]: Set of AP device MAC addresses to include in this AP group. MAC addresses are case-insensitive and may use : or - separators (e.g. aa:bb:cc:dd:ee:ff and AA-BB-CC-DD-EE-FF are treated as the same address and produce no diff); the value is kept as written.
name str: The name of the AP group.
site str: The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.

deviceMacs List<String>: Set of AP device MAC addresses to include in this AP group. MAC addresses are case-insensitive and may use : or - separators (e.g. aa:bb:cc:dd:ee:ff and AA-BB-CC-DD-EE-FF are treated as the same address and produce no diff); the value is kept as written.
name String: The name of the AP group.
site String: The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.

Import

The pulumi import command can be used, for example:

import from provider configured site

$ pulumi import unifi:ap/group:Group example 5dc28e5e9106d105bdc87217

import from another site

$ pulumi import unifi:ap/group:Group example another-site:5dc28e5e9106d105bdc87217

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: unifi pulumiverse/pulumi-unifi
License: Apache-2.0
Notes: This Pulumi package is based on the unifi Terraform Provider.

Viewing docs for Unifi v0.3.0
published on Wednesday, Jul 8, 2026 by Pulumiverse

Schema (JSON)

pulumiverse/pulumi-unifi

unifi.ap.Group

On this page

On this page

Example Usage

Create Group Resource

Constructor syntax

Parameters

Constructor example

Group Resource Properties

Inputs

Outputs

Look up Existing Group Resource

Import

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

unifi.ap.Group

On this page

On this page

Example Usage

Create Group Resource

Constructor syntax

Parameters

Constructor example

Group Resource Properties

Inputs

Outputs

Look up Existing Group Resource

Import

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.