1. Packages
  2. Wavefront
  3. API Docs
  4. UserGroup
Wavefront v3.1.4 published on Friday, Sep 20, 2024 by Pulumi

wavefront.UserGroup

Explore with Pulumi AI

wavefront logo
Wavefront v3.1.4 published on Friday, Sep 20, 2024 by Pulumi

    Provides a Wavefront User Group Resource. This allows user groups to be created, updated, and deleted.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as wavefront from "@pulumi/wavefront";
    
    const basic = new wavefront.UserGroup("basic", {
        name: "Basic User Group",
        description: "Basic User Group for Unit Tests",
    });
    
    import pulumi
    import pulumi_wavefront as wavefront
    
    basic = wavefront.UserGroup("basic",
        name="Basic User Group",
        description="Basic User Group for Unit Tests")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-wavefront/sdk/v3/go/wavefront"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := wavefront.NewUserGroup(ctx, "basic", &wavefront.UserGroupArgs{
    			Name:        pulumi.String("Basic User Group"),
    			Description: pulumi.String("Basic User Group for Unit Tests"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Wavefront = Pulumi.Wavefront;
    
    return await Deployment.RunAsync(() => 
    {
        var basic = new Wavefront.UserGroup("basic", new()
        {
            Name = "Basic User Group",
            Description = "Basic User Group for Unit Tests",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.wavefront.UserGroup;
    import com.pulumi.wavefront.UserGroupArgs;
    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 basic = new UserGroup("basic", UserGroupArgs.builder()
                .name("Basic User Group")
                .description("Basic User Group for Unit Tests")
                .build());
    
        }
    }
    
    resources:
      basic:
        type: wavefront:UserGroup
        properties:
          name: Basic User Group
          description: Basic User Group for Unit Tests
    

    Create UserGroup Resource

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

    Constructor syntax

    new UserGroup(name: string, args: UserGroupArgs, opts?: CustomResourceOptions);
    @overload
    def UserGroup(resource_name: str,
                  args: UserGroupArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def UserGroup(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  description: Optional[str] = None,
                  name: Optional[str] = None)
    func NewUserGroup(ctx *Context, name string, args UserGroupArgs, opts ...ResourceOption) (*UserGroup, error)
    public UserGroup(string name, UserGroupArgs args, CustomResourceOptions? opts = null)
    public UserGroup(String name, UserGroupArgs args)
    public UserGroup(String name, UserGroupArgs args, CustomResourceOptions options)
    
    type: wavefront:UserGroup
    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 UserGroupArgs
    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 UserGroupArgs
    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 UserGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserGroupArgs
    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 userGroupResource = new Wavefront.UserGroup("userGroupResource", new()
    {
        Description = "string",
        Name = "string",
    });
    
    example, err := wavefront.NewUserGroup(ctx, "userGroupResource", &wavefront.UserGroupArgs{
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    })
    
    var userGroupResource = new UserGroup("userGroupResource", UserGroupArgs.builder()
        .description("string")
        .name("string")
        .build());
    
    user_group_resource = wavefront.UserGroup("userGroupResource",
        description="string",
        name="string")
    
    const userGroupResource = new wavefront.UserGroup("userGroupResource", {
        description: "string",
        name: "string",
    });
    
    type: wavefront:UserGroup
    properties:
        description: string
        name: string
    

    UserGroup Resource Properties

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

    Inputs

    The UserGroup resource accepts the following input properties:

    Description string
    A short description of the user group.
    Name string
    The name of the user group.
    Description string
    A short description of the user group.
    Name string
    The name of the user group.
    description String
    A short description of the user group.
    name String
    The name of the user group.
    description string
    A short description of the user group.
    name string
    The name of the user group.
    description str
    A short description of the user group.
    name str
    The name of the user group.
    description String
    A short description of the user group.
    name String
    The name of the user group.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the UserGroup 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 UserGroup Resource

    Get an existing UserGroup 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?: UserGroupState, opts?: CustomResourceOptions): UserGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            name: Optional[str] = None) -> UserGroup
    func GetUserGroup(ctx *Context, name string, id IDInput, state *UserGroupState, opts ...ResourceOption) (*UserGroup, error)
    public static UserGroup Get(string name, Input<string> id, UserGroupState? state, CustomResourceOptions? opts = null)
    public static UserGroup get(String name, Output<String> id, UserGroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Description string
    A short description of the user group.
    Name string
    The name of the user group.
    Description string
    A short description of the user group.
    Name string
    The name of the user group.
    description String
    A short description of the user group.
    name String
    The name of the user group.
    description string
    A short description of the user group.
    name string
    The name of the user group.
    description str
    A short description of the user group.
    name str
    The name of the user group.
    description String
    A short description of the user group.
    name String
    The name of the user group.

    Import

    User Groups can be imported by using the id, e.g.:

    $ pulumi import wavefront:index/userGroup:UserGroup some_group a411c16b-3cf7-4f03-bf11-8ca05aab898d
    

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

    Package Details

    Repository
    Wavefront pulumi/pulumi-wavefront
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the wavefront Terraform Provider.
    wavefront logo
    Wavefront v3.1.4 published on Friday, Sep 20, 2024 by Pulumi