UNPKG

@crowdstrike/pulumi

Version:

A Pulumi package for creating and managing CrowdStrike resources. Based on terraform-provider-crowdstrike: version v0.0.4

162 lines (161 loc) 5.06 kB
import * as pulumi from "@pulumi/pulumi"; /** * 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 * * ```typescript * 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 * * host group can be imported by specifying the policy id. * * ```sh * $ pulumi import crowdstrike:index/hostGroup:HostGroup example 7fb858a949034a0cbca175f660f1e769 * ``` */ export declare class HostGroup extends pulumi.CustomResource { /** * Get an existing HostGroup resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input<pulumi.ID>, state?: HostGroupState, opts?: pulumi.CustomResourceOptions): HostGroup; /** * Returns true if the given object is an instance of HostGroup. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is HostGroup; /** * The assignment rule for dynamic host groups. */ readonly assignmentRule: pulumi.Output<string | undefined>; /** * Description of the host group. */ readonly description: pulumi.Output<string>; /** * List of host ids to add to a staticByID host group. */ readonly hostIds: pulumi.Output<string[] | undefined>; /** * List of hostnames to add to a static host group. */ readonly hostnames: pulumi.Output<string[] | undefined>; readonly lastUpdated: pulumi.Output<string>; /** * Name of the host group. */ readonly name: pulumi.Output<string>; /** * The host group type, case sensitive. (dynamic, static, staticByID) */ readonly type: pulumi.Output<string>; /** * Create a HostGroup resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: HostGroupArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering HostGroup resources. */ export interface HostGroupState { /** * The assignment rule for dynamic host groups. */ assignmentRule?: pulumi.Input<string>; /** * Description of the host group. */ description?: pulumi.Input<string>; /** * List of host ids to add to a staticByID host group. */ hostIds?: pulumi.Input<pulumi.Input<string>[]>; /** * List of hostnames to add to a static host group. */ hostnames?: pulumi.Input<pulumi.Input<string>[]>; lastUpdated?: pulumi.Input<string>; /** * Name of the host group. */ name?: pulumi.Input<string>; /** * The host group type, case sensitive. (dynamic, static, staticByID) */ type?: pulumi.Input<string>; } /** * The set of arguments for constructing a HostGroup resource. */ export interface HostGroupArgs { /** * The assignment rule for dynamic host groups. */ assignmentRule?: pulumi.Input<string>; /** * Description of the host group. */ description: pulumi.Input<string>; /** * List of host ids to add to a staticByID host group. */ hostIds?: pulumi.Input<pulumi.Input<string>[]>; /** * List of hostnames to add to a static host group. */ hostnames?: pulumi.Input<pulumi.Input<string>[]>; /** * Name of the host group. */ name?: pulumi.Input<string>; /** * The host group type, case sensitive. (dynamic, static, staticByID) */ type: pulumi.Input<string>; }