Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Wavefront Provider
  3. API Docs
  4. Role
Wavefront v3.1.8 published on Tuesday, Mar 4, 2025 by Pulumi
pulumi/pulumi-wavefront

wavefront.Role

Explore with Pulumi AI

Wavefront v3.1.8 published on Tuesday, Mar 4, 2025 by Pulumi
pulumi/pulumi-wavefront

Provides a Wavefront Role Resource. This allows roles to be created, updated, and deleted.

Example Usage

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

const role = new wavefront.Role("role", {name: "Test Role"});
Copy
import pulumi
import pulumi_wavefront as wavefront

role = wavefront.Role("role", name="Test Role")
Copy
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.NewRole(ctx, "role", &wavefront.RoleArgs{
			Name: pulumi.String("Test Role"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Wavefront = Pulumi.Wavefront;

return await Deployment.RunAsync(() => 
{
    var role = new Wavefront.Role("role", new()
    {
        Name = "Test Role",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.wavefront.Role;
import com.pulumi.wavefront.RoleArgs;
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 role = new Role("role", RoleArgs.builder()
            .name("Test Role")
            .build());

    }
}
Copy
resources:
  role:
    type: wavefront:Role
    properties:
      name: Test Role
Copy

Create Role Resource

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

Constructor syntax

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

@overload
def Role(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         assignees: Optional[Sequence[str]] = None,
         description: Optional[str] = None,
         name: Optional[str] = None,
         permissions: Optional[Sequence[str]] = None)
func NewRole(ctx *Context, name string, args *RoleArgs, opts ...ResourceOption) (*Role, error)
public Role(string name, RoleArgs? args = null, CustomResourceOptions? opts = null)
public Role(String name, RoleArgs args)
public Role(String name, RoleArgs args, CustomResourceOptions options)

type: wavefront:Role
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args RoleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args RoleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args RoleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args RoleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. RoleArgs
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 roleResource = new Wavefront.Role("roleResource", new()
{
    Assignees = new[]
    {
        "string",
    },
    Description = "string",
    Name = "string",
    Permissions = new[]
    {
        "string",
    },
});
Copy
example, err := wavefront.NewRole(ctx, "roleResource", &wavefront.RoleArgs{
	Assignees: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Permissions: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var roleResource = new Role("roleResource", RoleArgs.builder()
    .assignees("string")
    .description("string")
    .name("string")
    .permissions("string")
    .build());
Copy
role_resource = wavefront.Role("roleResource",
    assignees=["string"],
    description="string",
    name="string",
    permissions=["string"])
Copy
const roleResource = new wavefront.Role("roleResource", {
    assignees: ["string"],
    description: "string",
    name: "string",
    permissions: ["string"],
});
Copy
type: wavefront:Role
properties:
    assignees:
        - string
    description: string
    name: string
    permissions:
        - string
Copy

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

Assignees List<string>
A list of user groups or accounts to assign to this role.
Description string
A short description of the role.
Name string
The name of the role.
Permissions List<string>
A list of permissions to assign to this role. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
Assignees []string
A list of user groups or accounts to assign to this role.
Description string
A short description of the role.
Name string
The name of the role.
Permissions []string
A list of permissions to assign to this role. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
assignees List<String>
A list of user groups or accounts to assign to this role.
description String
A short description of the role.
name String
The name of the role.
permissions List<String>
A list of permissions to assign to this role. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
assignees string[]
A list of user groups or accounts to assign to this role.
description string
A short description of the role.
name string
The name of the role.
permissions string[]
A list of permissions to assign to this role. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
assignees Sequence[str]
A list of user groups or accounts to assign to this role.
description str
A short description of the role.
name str
The name of the role.
permissions Sequence[str]
A list of permissions to assign to this role. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
assignees List<String>
A list of user groups or accounts to assign to this role.
description String
A short description of the role.
name String
The name of the role.
permissions List<String>
A list of permissions to assign to this role. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.

Outputs

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

Get an existing Role 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?: RoleState, opts?: CustomResourceOptions): Role
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        assignees: Optional[Sequence[str]] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        permissions: Optional[Sequence[str]] = None) -> Role
func GetRole(ctx *Context, name string, id IDInput, state *RoleState, opts ...ResourceOption) (*Role, error)
public static Role Get(string name, Input<string> id, RoleState? state, CustomResourceOptions? opts = null)
public static Role get(String name, Output<String> id, RoleState state, CustomResourceOptions options)
resources:  _:    type: wavefront:Role    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Assignees List<string>
A list of user groups or accounts to assign to this role.
Description string
A short description of the role.
Name string
The name of the role.
Permissions List<string>
A list of permissions to assign to this role. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
Assignees []string
A list of user groups or accounts to assign to this role.
Description string
A short description of the role.
Name string
The name of the role.
Permissions []string
A list of permissions to assign to this role. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
assignees List<String>
A list of user groups or accounts to assign to this role.
description String
A short description of the role.
name String
The name of the role.
permissions List<String>
A list of permissions to assign to this role. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
assignees string[]
A list of user groups or accounts to assign to this role.
description string
A short description of the role.
name string
The name of the role.
permissions string[]
A list of permissions to assign to this role. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
assignees Sequence[str]
A list of user groups or accounts to assign to this role.
description str
A short description of the role.
name str
The name of the role.
permissions Sequence[str]
A list of permissions to assign to this role. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
assignees List<String>
A list of user groups or accounts to assign to this role.
description String
A short description of the role.
name String
The name of the role.
permissions List<String>
A list of permissions to assign to this role. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.

Import

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

$ pulumi import wavefront:index/role:Role some_role a411c16b-3cf7-4f03-bf11-8ca05aab898d
Copy

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 v3.1.8 published on Tuesday, Mar 4, 2025 by Pulumi
pulumi/pulumi-wavefront