Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Wavefront Provider
  3. API Docs
  4. User
Wavefront v3.1.6 published on Thursday, Oct 31, 2024 by Pulumi
pulumi/pulumi-wavefront

wavefront.User

Explore with Pulumi AI

wavefront logo
Wavefront v3.1.6 published on Thursday, Oct 31, 2024 by Pulumi
pulumi/pulumi-wavefront

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

    Example Usage

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

const basic = new wavefront.User("basic", {email: "test+tftesting@example.com"});

    import pulumi
import pulumi_wavefront as wavefront

basic = wavefront.User("basic", email="test+tftesting@example.com")

    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.NewUser(ctx, "basic", &wavefront.UserArgs{
			Email: pulumi.String("test+tftesting@example.com"),
		})
		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.User("basic", new()
    {
        Email = "test+tftesting@example.com",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.wavefront.User;
import com.pulumi.wavefront.UserArgs;
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 User("basic", UserArgs.builder()
            .email("test+tftesting@example.com")
            .build());

    }
}

    resources:
  basic:
    type: wavefront:User
    properties:
      email: test+tftesting@example.com

    Create User Resource

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

    Constructor syntax

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

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         email: Optional[str] = None,
         customer: Optional[str] = None,
         permissions: Optional[Sequence[str]] = None,
         user_groups: Optional[Sequence[str]] = None)
    func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
    public User(string name, UserArgs args, CustomResourceOptions? opts = null)
    public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

    type: wavefront:User
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 UserArgs
    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 UserArgs
    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 UserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserArgs
    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 userResource = new Wavefront.User("userResource", new()
{
    Email = "string",
    Customer = "string",
    Permissions = new[]
    {
        "string",
    },
    UserGroups = new[]
    {
        "string",
    },
});

    example, err := wavefront.NewUser(ctx, "userResource", &wavefront.UserArgs{
	Email:    pulumi.String("string"),
	Customer: pulumi.String("string"),
	Permissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	UserGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var userResource = new User("userResource", UserArgs.builder()
    .email("string")
    .customer("string")
    .permissions("string")
    .userGroups("string")
    .build());

    user_resource = wavefront.User("userResource",
    email="string",
    customer="string",
    permissions=["string"],
    user_groups=["string"])

    const userResource = new wavefront.User("userResource", {
    email: "string",
    customer: "string",
    permissions: ["string"],
    userGroups: ["string"],
});

    type: wavefront:User
properties:
    customer: string
    email: string
    permissions:
        - string
    userGroups:
        - string

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

    Email string
    The unique identifier of the user account to create. Must be a valid email address.
    Customer string
    The customer the user is associated with.
    Permissions List<string>
    List of permission to grant to this user. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
    UserGroups List<string>
    List of user groups to this user.
    Email string
    The unique identifier of the user account to create. Must be a valid email address.
    Customer string
    The customer the user is associated with.
    Permissions []string
    List of permission to grant to this user. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
    UserGroups []string
    List of user groups to this user.
    email String
    The unique identifier of the user account to create. Must be a valid email address.
    customer String
    The customer the user is associated with.
    permissions List<String>
    List of permission to grant to this user. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
    userGroups List<String>
    List of user groups to this user.
    email string
    The unique identifier of the user account to create. Must be a valid email address.
    customer string
    The customer the user is associated with.
    permissions string[]
    List of permission to grant to this user. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
    userGroups string[]
    List of user groups to this user.
    email str
    The unique identifier of the user account to create. Must be a valid email address.
    customer str
    The customer the user is associated with.
    permissions Sequence[str]
    List of permission to grant to this user. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
    user_groups Sequence[str]
    List of user groups to this user.
    email String
    The unique identifier of the user account to create. Must be a valid email address.
    customer String
    The customer the user is associated with.
    permissions List<String>
    List of permission to grant to this user. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
    userGroups List<String>
    List of user groups to this user.

    Outputs

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

    Get an existing User 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?: UserState, opts?: CustomResourceOptions): User
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        customer: Optional[str] = None,
        email: Optional[str] = None,
        permissions: Optional[Sequence[str]] = None,
        user_groups: Optional[Sequence[str]] = None) -> User
    func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
    public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
    public static User get(String name, Output<String> id, UserState 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:
    Customer string
    The customer the user is associated with.
    Email string
    The unique identifier of the user account to create. Must be a valid email address.
    Permissions List<string>
    List of permission to grant to this user. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
    UserGroups List<string>
    List of user groups to this user.
    Customer string
    The customer the user is associated with.
    Email string
    The unique identifier of the user account to create. Must be a valid email address.
    Permissions []string
    List of permission to grant to this user. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
    UserGroups []string
    List of user groups to this user.
    customer String
    The customer the user is associated with.
    email String
    The unique identifier of the user account to create. Must be a valid email address.
    permissions List<String>
    List of permission to grant to this user. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
    userGroups List<String>
    List of user groups to this user.
    customer string
    The customer the user is associated with.
    email string
    The unique identifier of the user account to create. Must be a valid email address.
    permissions string[]
    List of permission to grant to this user. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
    userGroups string[]
    List of user groups to this user.
    customer str
    The customer the user is associated with.
    email str
    The unique identifier of the user account to create. Must be a valid email address.
    permissions Sequence[str]
    List of permission to grant to this user. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
    user_groups Sequence[str]
    List of user groups to this user.
    customer String
    The customer the user is associated with.
    email String
    The unique identifier of the user account to create. Must be a valid email address.
    permissions List<String>
    List of permission to grant to this user. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
    userGroups List<String>
    List of user groups to this user.

    Import

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

    $ pulumi import wavefront:index/user:User some_user test@example.com

    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.6 published on Thursday, Oct 31, 2024 by Pulumi
    pulumi/pulumi-wavefront