Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Netbox Provider
  3. API Docs
  4. ClusterGroup
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
e-breuninger/terraform-provider-netbox

netbox.ClusterGroup

Explore with Pulumi AI

netbox logo
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
e-breuninger/terraform-provider-netbox

    From the official documentation:

    Cluster groups may be created for the purpose of organizing clusters. The arrangement of clusters into groups is optional.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as netbox from "@pulumi/netbox";

const dcWest = new netbox.ClusterGroup("dcWest", {description: "West Datacenter Cluster"});

    import pulumi
import pulumi_netbox as netbox

dc_west = netbox.ClusterGroup("dcWest", description="West Datacenter Cluster")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/netbox/v3/netbox"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := netbox.NewClusterGroup(ctx, "dcWest", &netbox.ClusterGroupArgs{
			Description: pulumi.String("West Datacenter Cluster"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Netbox = Pulumi.Netbox;

return await Deployment.RunAsync(() => 
{
    var dcWest = new Netbox.ClusterGroup("dcWest", new()
    {
        Description = "West Datacenter Cluster",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netbox.ClusterGroup;
import com.pulumi.netbox.ClusterGroupArgs;
import java.util.List;
import java.util.ArrayList;
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 dcWest = new ClusterGroup("dcWest", ClusterGroupArgs.builder()
            .description("West Datacenter Cluster")
            .build());

    }
}

    resources:
  dcWest:
    type: netbox:ClusterGroup
    properties:
      description: West Datacenter Cluster

    Create ClusterGroup Resource

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

    Constructor syntax

    new ClusterGroup(name: string, args?: ClusterGroupArgs, opts?: CustomResourceOptions);
    @overload
def ClusterGroup(resource_name: str,
                 args: Optional[ClusterGroupArgs] = None,
                 opts: Optional[ResourceOptions] = None)

@overload
def ClusterGroup(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 cluster_group_id: Optional[str] = None,
                 description: Optional[str] = None,
                 name: Optional[str] = None,
                 slug: Optional[str] = None)
    func NewClusterGroup(ctx *Context, name string, args *ClusterGroupArgs, opts ...ResourceOption) (*ClusterGroup, error)
    public ClusterGroup(string name, ClusterGroupArgs? args = null, CustomResourceOptions? opts = null)
    public ClusterGroup(String name, ClusterGroupArgs args)
public ClusterGroup(String name, ClusterGroupArgs args, CustomResourceOptions options)

    type: netbox:ClusterGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ClusterGroupArgs
    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 ClusterGroupArgs
    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 ClusterGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterGroupArgs
    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 clusterGroupResource = new Netbox.ClusterGroup("clusterGroupResource", new()
{
    ClusterGroupId = "string",
    Description = "string",
    Name = "string",
    Slug = "string",
});

    example, err := netbox.NewClusterGroup(ctx, "clusterGroupResource", &netbox.ClusterGroupArgs{
	ClusterGroupId: pulumi.String("string"),
	Description:    pulumi.String("string"),
	Name:           pulumi.String("string"),
	Slug:           pulumi.String("string"),
})

    var clusterGroupResource = new ClusterGroup("clusterGroupResource", ClusterGroupArgs.builder()
    .clusterGroupId("string")
    .description("string")
    .name("string")
    .slug("string")
    .build());

    cluster_group_resource = netbox.ClusterGroup("clusterGroupResource",
    cluster_group_id="string",
    description="string",
    name="string",
    slug="string")

    const clusterGroupResource = new netbox.ClusterGroup("clusterGroupResource", {
    clusterGroupId: "string",
    description: "string",
    name: "string",
    slug: "string",
});

    type: netbox:ClusterGroup
properties:
    clusterGroupId: string
    description: string
    name: string
    slug: string

    ClusterGroup 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 ClusterGroup resource accepts the following input properties:

    ClusterGroupId string
    The ID of this resource.
    Description string
    Name string
    Slug string
    ClusterGroupId string
    The ID of this resource.
    Description string
    Name string
    Slug string
    clusterGroupId String
    The ID of this resource.
    description String
    name String
    slug String
    clusterGroupId string
    The ID of this resource.
    description string
    name string
    slug string
    cluster_group_id str
    The ID of this resource.
    description str
    name str
    slug str
    clusterGroupId String
    The ID of this resource.
    description String
    name String
    slug String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ClusterGroup 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 str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ClusterGroup Resource

    Get an existing ClusterGroup 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?: ClusterGroupState, opts?: CustomResourceOptions): ClusterGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_group_id: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        slug: Optional[str] = None) -> ClusterGroup
    func GetClusterGroup(ctx *Context, name string, id IDInput, state *ClusterGroupState, opts ...ResourceOption) (*ClusterGroup, error)
    public static ClusterGroup Get(string name, Input<string> id, ClusterGroupState? state, CustomResourceOptions? opts = null)
    public static ClusterGroup get(String name, Output<String> id, ClusterGroupState state, CustomResourceOptions options)
    resources:  _:    type: netbox:ClusterGroup    get:      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:
    ClusterGroupId string
    The ID of this resource.
    Description string
    Name string
    Slug string
    ClusterGroupId string
    The ID of this resource.
    Description string
    Name string
    Slug string
    clusterGroupId String
    The ID of this resource.
    description String
    name String
    slug String
    clusterGroupId string
    The ID of this resource.
    description string
    name string
    slug string
    cluster_group_id str
    The ID of this resource.
    description str
    name str
    slug str
    clusterGroupId String
    The ID of this resource.
    description String
    name String
    slug String

    Package Details

    Repository
    netbox e-breuninger/terraform-provider-netbox
    License
    Notes
    This Pulumi package is based on the netbox Terraform Provider.
    netbox logo
    netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
    e-breuninger/terraform-provider-netbox