Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Datadog Provider
  3. API Docs
  4. Role
Datadog v4.36.1 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-datadog

datadog.Role

Explore with Pulumi AI

datadog logo
Datadog v4.36.1 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-datadog

    Provides a Datadog role resource. This can be used to create and manage Datadog roles.

    Example Usage

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

// Source the permissions
const bar = datadog.getPermissions({});
// Create a new Datadog role
const foo = new datadog.Role("foo", {
    name: "foo",
    permissions: [
        {
            id: bar.then(bar => bar.permissions?.monitorsDowntime),
        },
        {
            id: bar.then(bar => bar.permissions?.monitorsWrite),
        },
    ],
});

    import pulumi
import pulumi_datadog as datadog

# Source the permissions
bar = datadog.get_permissions()
# Create a new Datadog role
foo = datadog.Role("foo",
    name="foo",
    permissions=[
        {
            "id": bar.permissions["monitorsDowntime"],
        },
        {
            "id": bar.permissions["monitorsWrite"],
        },
    ])

    package main

import (
	"github.com/pulumi/pulumi-datadog/sdk/v4/go/datadog"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Source the permissions
		bar, err := datadog.GetPermissions(ctx, &datadog.GetPermissionsArgs{}, nil)
		if err != nil {
			return err
		}
		// Create a new Datadog role
		_, err = datadog.NewRole(ctx, "foo", &datadog.RoleArgs{
			Name: pulumi.String("foo"),
			Permissions: datadog.RolePermissionArray{
				&datadog.RolePermissionArgs{
					Id: pulumi.String(bar.Permissions.MonitorsDowntime),
				},
				&datadog.RolePermissionArgs{
					Id: pulumi.String(bar.Permissions.MonitorsWrite),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Datadog = Pulumi.Datadog;

return await Deployment.RunAsync(() => 
{
    // Source the permissions
    var bar = Datadog.GetPermissions.Invoke();

    // Create a new Datadog role
    var foo = new Datadog.Role("foo", new()
    {
        Name = "foo",
        Permissions = new[]
        {
            new Datadog.Inputs.RolePermissionArgs
            {
                Id = bar.Apply(getPermissionsResult => getPermissionsResult.Permissions?.MonitorsDowntime),
            },
            new Datadog.Inputs.RolePermissionArgs
            {
                Id = bar.Apply(getPermissionsResult => getPermissionsResult.Permissions?.MonitorsWrite),
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.datadog.DatadogFunctions;
import com.pulumi.datadog.inputs.GetPermissionsArgs;
import com.pulumi.datadog.Role;
import com.pulumi.datadog.RoleArgs;
import com.pulumi.datadog.inputs.RolePermissionArgs;
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) {
        // Source the permissions
        final var bar = DatadogFunctions.getPermissions();

        // Create a new Datadog role
        var foo = new Role("foo", RoleArgs.builder()
            .name("foo")
            .permissions(            
                RolePermissionArgs.builder()
                    .id(bar.applyValue(getPermissionsResult -> getPermissionsResult.permissions().monitorsDowntime()))
                    .build(),
                RolePermissionArgs.builder()
                    .id(bar.applyValue(getPermissionsResult -> getPermissionsResult.permissions().monitorsWrite()))
                    .build())
            .build());

    }
}

    resources:
  # Create a new Datadog role
  foo:
    type: datadog:Role
    properties:
      name: foo
      permissions:
        - id: ${bar.permissions.monitorsDowntime}
        - id: ${bar.permissions.monitorsWrite}
variables:
  # Source the permissions
  bar:
    fn::invoke:
      Function: datadog:getPermissions
      Arguments: {}

    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: RoleArgs,
         opts: Optional[ResourceOptions] = None)

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

    type: datadog:Role
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 RoleArgs
    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 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 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 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 String
    The unique name of the resource.
    args 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 Datadog.Role("roleResource", new()
{
    Name = "string",
    Permissions = new[]
    {
        new Datadog.Inputs.RolePermissionArgs
        {
            Id = "string",
            Name = "string",
        },
    },
    Validate = false,
});

    example, err := datadog.NewRole(ctx, "roleResource", &datadog.RoleArgs{
	Name: pulumi.String("string"),
	Permissions: datadog.RolePermissionArray{
		&datadog.RolePermissionArgs{
			Id:   pulumi.String("string"),
			Name: pulumi.String("string"),
		},
	},
	Validate: pulumi.Bool(false),
})

    var roleResource = new Role("roleResource", RoleArgs.builder()
    .name("string")
    .permissions(RolePermissionArgs.builder()
        .id("string")
        .name("string")
        .build())
    .validate(false)
    .build());

    role_resource = datadog.Role("roleResource",
    name="string",
    permissions=[{
        "id": "string",
        "name": "string",
    }],
    validate=False)

    const roleResource = new datadog.Role("roleResource", {
    name: "string",
    permissions: [{
        id: "string",
        name: "string",
    }],
    validate: false,
});

    type: datadog:Role
properties:
    name: string
    permissions:
        - id: string
          name: string
    validate: false

    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:

    Name string
    Name of the role.
    Permissions List<RolePermission>
    Set of objects containing the permission ID and the name of the permissions granted to this role.
    Validate bool
    If set to false, skip the validation call done during plan.
    Name string
    Name of the role.
    Permissions []RolePermissionArgs
    Set of objects containing the permission ID and the name of the permissions granted to this role.
    Validate bool
    If set to false, skip the validation call done during plan.
    name String
    Name of the role.
    permissions List<RolePermission>
    Set of objects containing the permission ID and the name of the permissions granted to this role.
    validate Boolean
    If set to false, skip the validation call done during plan.
    name string
    Name of the role.
    permissions RolePermission[]
    Set of objects containing the permission ID and the name of the permissions granted to this role.
    validate boolean
    If set to false, skip the validation call done during plan.
    name str
    Name of the role.
    permissions Sequence[RolePermissionArgs]
    Set of objects containing the permission ID and the name of the permissions granted to this role.
    validate bool
    If set to false, skip the validation call done during plan.
    name String
    Name of the role.
    permissions List<Property Map>
    Set of objects containing the permission ID and the name of the permissions granted to this role.
    validate Boolean
    If set to false, skip the validation call done during plan.

    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.
    UserCount int
    Number of users that have this role.
    Id string
    The provider-assigned unique ID for this managed resource.
    UserCount int
    Number of users that have this role.
    id String
    The provider-assigned unique ID for this managed resource.
    userCount Integer
    Number of users that have this role.
    id string
    The provider-assigned unique ID for this managed resource.
    userCount number
    Number of users that have this role.
    id str
    The provider-assigned unique ID for this managed resource.
    user_count int
    Number of users that have this role.
    id String
    The provider-assigned unique ID for this managed resource.
    userCount Number
    Number of users that have this role.

    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,
        name: Optional[str] = None,
        permissions: Optional[Sequence[RolePermissionArgs]] = None,
        user_count: Optional[int] = None,
        validate: Optional[bool] = 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)
    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:
    Name string
    Name of the role.
    Permissions List<RolePermission>
    Set of objects containing the permission ID and the name of the permissions granted to this role.
    UserCount int
    Number of users that have this role.
    Validate bool
    If set to false, skip the validation call done during plan.
    Name string
    Name of the role.
    Permissions []RolePermissionArgs
    Set of objects containing the permission ID and the name of the permissions granted to this role.
    UserCount int
    Number of users that have this role.
    Validate bool
    If set to false, skip the validation call done during plan.
    name String
    Name of the role.
    permissions List<RolePermission>
    Set of objects containing the permission ID and the name of the permissions granted to this role.
    userCount Integer
    Number of users that have this role.
    validate Boolean
    If set to false, skip the validation call done during plan.
    name string
    Name of the role.
    permissions RolePermission[]
    Set of objects containing the permission ID and the name of the permissions granted to this role.
    userCount number
    Number of users that have this role.
    validate boolean
    If set to false, skip the validation call done during plan.
    name str
    Name of the role.
    permissions Sequence[RolePermissionArgs]
    Set of objects containing the permission ID and the name of the permissions granted to this role.
    user_count int
    Number of users that have this role.
    validate bool
    If set to false, skip the validation call done during plan.
    name String
    Name of the role.
    permissions List<Property Map>
    Set of objects containing the permission ID and the name of the permissions granted to this role.
    userCount Number
    Number of users that have this role.
    validate Boolean
    If set to false, skip the validation call done during plan.

    Supporting Types

    RolePermission, RolePermissionArgs

    Id string
    ID of the permission to assign.
    Name string
    Name of the permission.
    Id string
    ID of the permission to assign.
    Name string
    Name of the permission.
    id String
    ID of the permission to assign.
    name String
    Name of the permission.
    id string
    ID of the permission to assign.
    name string
    Name of the permission.
    id str
    ID of the permission to assign.
    name str
    Name of the permission.
    id String
    ID of the permission to assign.
    name String
    Name of the permission.

    Import

    Roles can be imported using their ID, e.g.

    $ pulumi import datadog:index/role:Role example_role 000000-0000-0000-0000-000000000000

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

    Package Details

    Repository
    Datadog pulumi/pulumi-datadog
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the datadog Terraform Provider.
    datadog logo
    Datadog v4.36.1 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-datadog