UNPKG

@pulumi/scm

Version:

A Pulumi package for managing resources on Strata Cloud Manager.. Based on terraform-provider-scm: version v0.2.1

176 lines (175 loc) 5.77 kB
import * as pulumi from "@pulumi/pulumi"; /** * DynamicUserGroup resource * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as scm from "@pulumi/scm"; * * // First, create the tags that will be used in the dynamic user group's filter. * const scmDugTag1 = new scm.Tag("scm_dug_tag_1", { * folder: "All", * name: "scm_dug_tag_1", * color: "Red", * }); * const scmDugTag2 = new scm.Tag("scm_dug_tag_2", { * folder: "All", * name: "scm_dug_tag_2", * color: "Blue", * }); * const scmDugTag3 = new scm.Tag("scm_dug_tag_3", { * folder: "All", * name: "scm_dug_tag_3", * color: "Green", * }); * // Create the dynamic user group that references the tags above. * const scmDug1 = new scm.DynamicUserGroup("scm_dug_1", { * folder: "Shared", * name: "scm_dug_1", * description: "DUG created for Terraform", * filter: pulumi.interpolate`'${scmDugTag1.name}' or '${scmDugTag2.name}' and '${scmDugTag3.name}'`, * tags: [scmDugTag1.name], * }, { * dependsOn: [ * scmDugTag1, * scmDugTag2, * scmDugTag3, * ], * }); * ``` */ export declare class DynamicUserGroup extends pulumi.CustomResource { /** * Get an existing DynamicUserGroup 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?: DynamicUserGroupState, opts?: pulumi.CustomResourceOptions): DynamicUserGroup; /** * Returns true if the given object is an instance of DynamicUserGroup. 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 DynamicUserGroup; /** * The description of the dynamic address group */ readonly description: pulumi.Output<string | undefined>; /** * The device in which the resource is defined */ readonly device: pulumi.Output<string | undefined>; /** * The tag-based filter for the dynamic user group */ readonly filter: pulumi.Output<string>; /** * The folder in which the resource is defined * * > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`. */ readonly folder: pulumi.Output<string | undefined>; /** * The name of the dynamic address group */ readonly name: pulumi.Output<string>; /** * The snippet in which the resource is defined * * > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`. */ readonly snippet: pulumi.Output<string | undefined>; /** * Tags associated with the dynamic user group */ readonly tags: pulumi.Output<string[] | undefined>; readonly tfid: pulumi.Output<string>; /** * Create a DynamicUserGroup 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: DynamicUserGroupArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering DynamicUserGroup resources. */ export interface DynamicUserGroupState { /** * The description of the dynamic address group */ description?: pulumi.Input<string>; /** * The device in which the resource is defined */ device?: pulumi.Input<string>; /** * The tag-based filter for the dynamic user group */ filter?: pulumi.Input<string>; /** * The folder in which the resource is defined * * > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`. */ folder?: pulumi.Input<string>; /** * The name of the dynamic address group */ name?: pulumi.Input<string>; /** * The snippet in which the resource is defined * * > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`. */ snippet?: pulumi.Input<string>; /** * Tags associated with the dynamic user group */ tags?: pulumi.Input<pulumi.Input<string>[]>; tfid?: pulumi.Input<string>; } /** * The set of arguments for constructing a DynamicUserGroup resource. */ export interface DynamicUserGroupArgs { /** * The description of the dynamic address group */ description?: pulumi.Input<string>; /** * The device in which the resource is defined */ device?: pulumi.Input<string>; /** * The tag-based filter for the dynamic user group */ filter: pulumi.Input<string>; /** * The folder in which the resource is defined * * > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`. */ folder?: pulumi.Input<string>; /** * The name of the dynamic address group */ name?: pulumi.Input<string>; /** * The snippet in which the resource is defined * * > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`. */ snippet?: pulumi.Input<string>; /** * Tags associated with the dynamic user group */ tags?: pulumi.Input<pulumi.Input<string>[]>; }