Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. CrowdStrike
  3. API Docs
  4. HostGroup
CrowdStrike v0.0.10 published on Monday, Mar 3, 2025 by CrowdStrike
crowdstrike/pulumi-crowdstrike

crowdstrike.HostGroup

Explore with Pulumi AI

crowdstrike logo
CrowdStrike v0.0.10 published on Monday, Mar 3, 2025 by CrowdStrike
crowdstrike/pulumi-crowdstrike

    This resource allows you to manage host groups in the CrowdStrike Falcon Platform.

    API Scopes

    The following API scopes are required:

    • Host groups | Read & Write
    • Firewall management | Read & Write
    • Prevention policies | Read & Write
    • Response policies | Read & Write
    • Sensor update policies | Read & Write

    Example Usage

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

const dynamic = new crowdstrike.HostGroup("dynamic", {
    assignmentRule: "tags:'SensorGroupingTags/molecule'+os_version:'Debian GNU 11'",
    description: "Made with Pulumi",
    type: "dynamic",
});
const static = new crowdstrike.HostGroup("static", {
    description: "Made with Pulumi",
    type: "staticByID",
    hostIds: [
        "host1",
        "host2",
    ],
});
const staticByID = new crowdstrike.HostGroup("staticByID", {
    description: "Made with Pulumi",
    type: "staticByID",
    hostIds: [
        "123123",
        "124124",
    ],
});
export const hostGroup = dynamic;

    import pulumi
import crowdstrike_pulumi as crowdstrike

dynamic = crowdstrike.HostGroup("dynamic",
    assignment_rule="tags:'SensorGroupingTags/molecule'+os_version:'Debian GNU 11'",
    description="Made with Pulumi",
    type="dynamic")
static = crowdstrike.HostGroup("static",
    description="Made with Pulumi",
    type="staticByID",
    host_ids=[
        "host1",
        "host2",
    ])
static_by_id = crowdstrike.HostGroup("staticByID",
    description="Made with Pulumi",
    type="staticByID",
    host_ids=[
        "123123",
        "124124",
    ])
pulumi.export("hostGroup", dynamic)

    package main

import (
	"github.com/crowdstrike/pulumi-crowdstrike/sdk/go/crowdstrike"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		dynamic, err := crowdstrike.NewHostGroup(ctx, "dynamic", &crowdstrike.HostGroupArgs{
			AssignmentRule: pulumi.String("tags:'SensorGroupingTags/molecule'+os_version:'Debian GNU 11'"),
			Description:    pulumi.String("Made with Pulumi"),
			Type:           pulumi.String("dynamic"),
		})
		if err != nil {
			return err
		}
		_, err = crowdstrike.NewHostGroup(ctx, "static", &crowdstrike.HostGroupArgs{
			Description: pulumi.String("Made with Pulumi"),
			Type:        pulumi.String("staticByID"),
			HostIds: pulumi.StringArray{
				pulumi.String("host1"),
				pulumi.String("host2"),
			},
		})
		if err != nil {
			return err
		}
		_, err = crowdstrike.NewHostGroup(ctx, "staticByID", &crowdstrike.HostGroupArgs{
			Description: pulumi.String("Made with Pulumi"),
			Type:        pulumi.String("staticByID"),
			HostIds: pulumi.StringArray{
				pulumi.String("123123"),
				pulumi.String("124124"),
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("hostGroup", dynamic)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Crowdstrike = CrowdStrike.Crowdstrike;

return await Deployment.RunAsync(() => 
{
    var @dynamic = new Crowdstrike.HostGroup("dynamic", new()
    {
        AssignmentRule = "tags:'SensorGroupingTags/molecule'+os_version:'Debian GNU 11'",
        Description = "Made with Pulumi",
        Type = "dynamic",
    });

    var @static = new Crowdstrike.HostGroup("static", new()
    {
        Description = "Made with Pulumi",
        Type = "staticByID",
        HostIds = new[]
        {
            "host1",
            "host2",
        },
    });

    var staticByID = new Crowdstrike.HostGroup("staticByID", new()
    {
        Description = "Made with Pulumi",
        Type = "staticByID",
        HostIds = new[]
        {
            "123123",
            "124124",
        },
    });

    return new Dictionary<string, object?>
    {
        ["hostGroup"] = @dynamic,
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.crowdstrike.HostGroup;
import com.pulumi.crowdstrike.HostGroupArgs;
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 dynamic = new HostGroup("dynamic", HostGroupArgs.builder()
            .assignmentRule("tags:'SensorGroupingTags/molecule'+os_version:'Debian GNU 11'")
            .description("Made with Pulumi")
            .type("dynamic")
            .build());

        var static_ = new HostGroup("static", HostGroupArgs.builder()
            .description("Made with Pulumi")
            .type("staticByID")
            .hostIds(            
                "host1",
                "host2")
            .build());

        var staticByID = new HostGroup("staticByID", HostGroupArgs.builder()
            .description("Made with Pulumi")
            .type("staticByID")
            .hostIds(            
                "123123",
                "124124")
            .build());

        ctx.export("hostGroup", dynamic);
    }
}

    resources:
  dynamic:
    type: crowdstrike:HostGroup
    properties:
      assignmentRule: tags:'SensorGroupingTags/molecule'+os_version:'Debian GNU 11'
      description: Made with Pulumi
      type: dynamic
  static:
    type: crowdstrike:HostGroup
    properties:
      description: Made with Pulumi
      type: staticByID
      hostIds:
        - host1
        - host2
  staticByID:
    type: crowdstrike:HostGroup
    properties:
      description: Made with Pulumi
      type: staticByID
      hostIds:
        - '123123'
        - '124124'
outputs:
  hostGroup: ${dynamic}

    Create HostGroup Resource

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

    Constructor syntax

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

@overload
def HostGroup(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              description: Optional[str] = None,
              type: Optional[str] = None,
              assignment_rule: Optional[str] = None,
              host_ids: Optional[Sequence[str]] = None,
              hostnames: Optional[Sequence[str]] = None,
              name: Optional[str] = None)
    func NewHostGroup(ctx *Context, name string, args HostGroupArgs, opts ...ResourceOption) (*HostGroup, error)
    public HostGroup(string name, HostGroupArgs args, CustomResourceOptions? opts = null)
    public HostGroup(String name, HostGroupArgs args)
public HostGroup(String name, HostGroupArgs args, CustomResourceOptions options)

    type: crowdstrike:HostGroup
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 HostGroupArgs
    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 HostGroupArgs
    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 HostGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HostGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HostGroupArgs
    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 hostGroupResource = new Crowdstrike.HostGroup("hostGroupResource", new()
{
    Description = "string",
    Type = "string",
    AssignmentRule = "string",
    HostIds = new[]
    {
        "string",
    },
    Hostnames = new[]
    {
        "string",
    },
    Name = "string",
});

    example, err := crowdstrike.NewHostGroup(ctx, "hostGroupResource", &crowdstrike.HostGroupArgs{
	Description:    pulumi.String("string"),
	Type:           pulumi.String("string"),
	AssignmentRule: pulumi.String("string"),
	HostIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Hostnames: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

    var hostGroupResource = new HostGroup("hostGroupResource", HostGroupArgs.builder()
    .description("string")
    .type("string")
    .assignmentRule("string")
    .hostIds("string")
    .hostnames("string")
    .name("string")
    .build());

    host_group_resource = crowdstrike.HostGroup("hostGroupResource",
    description="string",
    type="string",
    assignment_rule="string",
    host_ids=["string"],
    hostnames=["string"],
    name="string")

    const hostGroupResource = new crowdstrike.HostGroup("hostGroupResource", {
    description: "string",
    type: "string",
    assignmentRule: "string",
    hostIds: ["string"],
    hostnames: ["string"],
    name: "string",
});

    type: crowdstrike:HostGroup
properties:
    assignmentRule: string
    description: string
    hostIds:
        - string
    hostnames:
        - string
    name: string
    type: string

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

    Description string
    Description of the host group.
    Type string
    The host group type, case sensitive. (dynamic, static, staticByID)
    AssignmentRule string
    The assignment rule for dynamic host groups.
    HostIds List<string>
    List of host ids to add to a staticByID host group.
    Hostnames List<string>
    List of hostnames to add to a static host group.
    Name string
    Name of the host group.
    Description string
    Description of the host group.
    Type string
    The host group type, case sensitive. (dynamic, static, staticByID)
    AssignmentRule string
    The assignment rule for dynamic host groups.
    HostIds []string
    List of host ids to add to a staticByID host group.
    Hostnames []string
    List of hostnames to add to a static host group.
    Name string
    Name of the host group.
    description String
    Description of the host group.
    type String
    The host group type, case sensitive. (dynamic, static, staticByID)
    assignmentRule String
    The assignment rule for dynamic host groups.
    hostIds List<String>
    List of host ids to add to a staticByID host group.
    hostnames List<String>
    List of hostnames to add to a static host group.
    name String
    Name of the host group.
    description string
    Description of the host group.
    type string
    The host group type, case sensitive. (dynamic, static, staticByID)
    assignmentRule string
    The assignment rule for dynamic host groups.
    hostIds string[]
    List of host ids to add to a staticByID host group.
    hostnames string[]
    List of hostnames to add to a static host group.
    name string
    Name of the host group.
    description str
    Description of the host group.
    type str
    The host group type, case sensitive. (dynamic, static, staticByID)
    assignment_rule str
    The assignment rule for dynamic host groups.
    host_ids Sequence[str]
    List of host ids to add to a staticByID host group.
    hostnames Sequence[str]
    List of hostnames to add to a static host group.
    name str
    Name of the host group.
    description String
    Description of the host group.
    type String
    The host group type, case sensitive. (dynamic, static, staticByID)
    assignmentRule String
    The assignment rule for dynamic host groups.
    hostIds List<String>
    List of host ids to add to a staticByID host group.
    hostnames List<String>
    List of hostnames to add to a static host group.
    name String
    Name of the host group.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdated string
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdated string
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdated String
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdated string
    id str
    The provider-assigned unique ID for this managed resource.
    last_updated str
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdated String

    Look up Existing HostGroup Resource

    Get an existing HostGroup 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?: HostGroupState, opts?: CustomResourceOptions): HostGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        assignment_rule: Optional[str] = None,
        description: Optional[str] = None,
        host_ids: Optional[Sequence[str]] = None,
        hostnames: Optional[Sequence[str]] = None,
        last_updated: Optional[str] = None,
        name: Optional[str] = None,
        type: Optional[str] = None) -> HostGroup
    func GetHostGroup(ctx *Context, name string, id IDInput, state *HostGroupState, opts ...ResourceOption) (*HostGroup, error)
    public static HostGroup Get(string name, Input<string> id, HostGroupState? state, CustomResourceOptions? opts = null)
    public static HostGroup get(String name, Output<String> id, HostGroupState state, CustomResourceOptions options)
    resources:  _:    type: crowdstrike:HostGroup    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:
    AssignmentRule string
    The assignment rule for dynamic host groups.
    Description string
    Description of the host group.
    HostIds List<string>
    List of host ids to add to a staticByID host group.
    Hostnames List<string>
    List of hostnames to add to a static host group.
    LastUpdated string
    Name string
    Name of the host group.
    Type string
    The host group type, case sensitive. (dynamic, static, staticByID)
    AssignmentRule string
    The assignment rule for dynamic host groups.
    Description string
    Description of the host group.
    HostIds []string
    List of host ids to add to a staticByID host group.
    Hostnames []string
    List of hostnames to add to a static host group.
    LastUpdated string
    Name string
    Name of the host group.
    Type string
    The host group type, case sensitive. (dynamic, static, staticByID)
    assignmentRule String
    The assignment rule for dynamic host groups.
    description String
    Description of the host group.
    hostIds List<String>
    List of host ids to add to a staticByID host group.
    hostnames List<String>
    List of hostnames to add to a static host group.
    lastUpdated String
    name String
    Name of the host group.
    type String
    The host group type, case sensitive. (dynamic, static, staticByID)
    assignmentRule string
    The assignment rule for dynamic host groups.
    description string
    Description of the host group.
    hostIds string[]
    List of host ids to add to a staticByID host group.
    hostnames string[]
    List of hostnames to add to a static host group.
    lastUpdated string
    name string
    Name of the host group.
    type string
    The host group type, case sensitive. (dynamic, static, staticByID)
    assignment_rule str
    The assignment rule for dynamic host groups.
    description str
    Description of the host group.
    host_ids Sequence[str]
    List of host ids to add to a staticByID host group.
    hostnames Sequence[str]
    List of hostnames to add to a static host group.
    last_updated str
    name str
    Name of the host group.
    type str
    The host group type, case sensitive. (dynamic, static, staticByID)
    assignmentRule String
    The assignment rule for dynamic host groups.
    description String
    Description of the host group.
    hostIds List<String>
    List of host ids to add to a staticByID host group.
    hostnames List<String>
    List of hostnames to add to a static host group.
    lastUpdated String
    name String
    Name of the host group.
    type String
    The host group type, case sensitive. (dynamic, static, staticByID)

    Import

    host group can be imported by specifying the policy id.

    $ pulumi import crowdstrike:index/hostGroup:HostGroup example 7fb858a949034a0cbca175f660f1e769

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

    Package Details

    Repository
    crowdstrike crowdstrike/pulumi-crowdstrike
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the crowdstrike Terraform Provider.
    crowdstrike logo
    CrowdStrike v0.0.10 published on Monday, Mar 3, 2025 by CrowdStrike
    crowdstrike/pulumi-crowdstrike