Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Discord Provider
  3. API Docs
  4. Role
discord 2.0.0 published on Friday, Mar 7, 2025 by lucky3028
lucky3028/terraform-provider-discord

discord.Role

Explore with Pulumi AI

discord logo
discord 2.0.0 published on Friday, Mar 7, 2025 by lucky3028
lucky3028/terraform-provider-discord

    A resource to create a role.

    Example Usage

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

const moderator = new discord.Role("moderator", {
    serverId: _var.server_id,
    permissions: data.discord_permission.moderator.allow_bits,
    color: data.discord_color.blue.dec,
    hoist: true,
    mentionable: true,
    position: 5,
});

    import pulumi
import pulumi_discord as discord

moderator = discord.Role("moderator",
    server_id=var["server_id"],
    permissions=data["discord_permission"]["moderator"]["allow_bits"],
    color=data["discord_color"]["blue"]["dec"],
    hoist=True,
    mentionable=True,
    position=5)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/discord/v2/discord"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := discord.NewRole(ctx, "moderator", &discord.RoleArgs{
			ServerId:    pulumi.Any(_var.Server_id),
			Permissions: pulumi.Any(data.Discord_permission.Moderator.Allow_bits),
			Color:       pulumi.Any(data.Discord_color.Blue.Dec),
			Hoist:       pulumi.Bool(true),
			Mentionable: pulumi.Bool(true),
			Position:    pulumi.Float64(5),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var moderator = new Discord.Role("moderator", new()
    {
        ServerId = @var.Server_id,
        Permissions = data.Discord_permission.Moderator.Allow_bits,
        Color = data.Discord_color.Blue.Dec,
        Hoist = true,
        Mentionable = true,
        Position = 5,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.discord.Role;
import com.pulumi.discord.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 moderator = new Role("moderator", RoleArgs.builder()
            .serverId(var_.server_id())
            .permissions(data.discord_permission().moderator().allow_bits())
            .color(data.discord_color().blue().dec())
            .hoist(true)
            .mentionable(true)
            .position(5)
            .build());

    }
}

    resources:
  moderator:
    type: discord:Role
    properties:
      serverId: ${var.server_id}
      permissions: ${data.discord_permission.moderator.allow_bits}
      color: ${data.discord_color.blue.dec}
      hoist: true
      mentionable: true
      position: 5

    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,
         server_id: Optional[str] = None,
         color: Optional[float] = None,
         hoist: Optional[bool] = None,
         mentionable: Optional[bool] = None,
         name: Optional[str] = None,
         permissions: Optional[float] = None,
         position: Optional[float] = 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: discord: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 Discord.Role("roleResource", new()
{
    ServerId = "string",
    Color = 0,
    Hoist = false,
    Mentionable = false,
    Name = "string",
    Permissions = 0,
    Position = 0,
});

    example, err := discord.NewRole(ctx, "roleResource", &discord.RoleArgs{
ServerId: pulumi.String("string"),
Color: pulumi.Float64(0),
Hoist: pulumi.Bool(false),
Mentionable: pulumi.Bool(false),
Name: pulumi.String("string"),
Permissions: pulumi.Float64(0),
Position: pulumi.Float64(0),
})

    var roleResource = new Role("roleResource", RoleArgs.builder()
    .serverId("string")
    .color(0)
    .hoist(false)
    .mentionable(false)
    .name("string")
    .permissions(0)
    .position(0)
    .build());

    role_resource = discord.Role("roleResource",
    server_id="string",
    color=0,
    hoist=False,
    mentionable=False,
    name="string",
    permissions=0,
    position=0)

    const roleResource = new discord.Role("roleResource", {
    serverId: "string",
    color: 0,
    hoist: false,
    mentionable: false,
    name: "string",
    permissions: 0,
    position: 0,
});

    type: discord:Role
properties:
    color: 0
    hoist: false
    mentionable: false
    name: string
    permissions: 0
    position: 0
    serverId: string

    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:

    ServerId string
    Which server the role will be in.
    Color double
    Integer representation of the role color with decimal color code.
    Hoist bool
    Whether the role should be hoisted. (default false)
    Mentionable bool
    Whether the role should be mentionable. (default false)
    Name string
    Name of the role.
    Permissions double
    Permission bits of the role.
    Position double
    Position of the role. This is reverse indexed, with @everyone being 0.
    ServerId string
    Which server the role will be in.
    Color float64
    Integer representation of the role color with decimal color code.
    Hoist bool
    Whether the role should be hoisted. (default false)
    Mentionable bool
    Whether the role should be mentionable. (default false)
    Name string
    Name of the role.
    Permissions float64
    Permission bits of the role.
    Position float64
    Position of the role. This is reverse indexed, with @everyone being 0.
    serverId String
    Which server the role will be in.
    color Double
    Integer representation of the role color with decimal color code.
    hoist Boolean
    Whether the role should be hoisted. (default false)
    mentionable Boolean
    Whether the role should be mentionable. (default false)
    name String
    Name of the role.
    permissions Double
    Permission bits of the role.
    position Double
    Position of the role. This is reverse indexed, with @everyone being 0.
    serverId string
    Which server the role will be in.
    color number
    Integer representation of the role color with decimal color code.
    hoist boolean
    Whether the role should be hoisted. (default false)
    mentionable boolean
    Whether the role should be mentionable. (default false)
    name string
    Name of the role.
    permissions number
    Permission bits of the role.
    position number
    Position of the role. This is reverse indexed, with @everyone being 0.
    server_id str
    Which server the role will be in.
    color float
    Integer representation of the role color with decimal color code.
    hoist bool
    Whether the role should be hoisted. (default false)
    mentionable bool
    Whether the role should be mentionable. (default false)
    name str
    Name of the role.
    permissions float
    Permission bits of the role.
    position float
    Position of the role. This is reverse indexed, with @everyone being 0.
    serverId String
    Which server the role will be in.
    color Number
    Integer representation of the role color with decimal color code.
    hoist Boolean
    Whether the role should be hoisted. (default false)
    mentionable Boolean
    Whether the role should be mentionable. (default false)
    name String
    Name of the role.
    permissions Number
    Permission bits of the role.
    position Number
    Position of the role. This is reverse indexed, with @everyone being 0.

    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.
    Managed bool
    Whether this role is managed by another service.
    Id string
    The provider-assigned unique ID for this managed resource.
    Managed bool
    Whether this role is managed by another service.
    id String
    The provider-assigned unique ID for this managed resource.
    managed Boolean
    Whether this role is managed by another service.
    id string
    The provider-assigned unique ID for this managed resource.
    managed boolean
    Whether this role is managed by another service.
    id str
    The provider-assigned unique ID for this managed resource.
    managed bool
    Whether this role is managed by another service.
    id String
    The provider-assigned unique ID for this managed resource.
    managed Boolean
    Whether this role is managed by another service.

    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,
        color: Optional[float] = None,
        hoist: Optional[bool] = None,
        managed: Optional[bool] = None,
        mentionable: Optional[bool] = None,
        name: Optional[str] = None,
        permissions: Optional[float] = None,
        position: Optional[float] = None,
        server_id: Optional[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: discord:Role    get:      id: ${id}
    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:
    Color double
    Integer representation of the role color with decimal color code.
    Hoist bool
    Whether the role should be hoisted. (default false)
    Managed bool
    Whether this role is managed by another service.
    Mentionable bool
    Whether the role should be mentionable. (default false)
    Name string
    Name of the role.
    Permissions double
    Permission bits of the role.
    Position double
    Position of the role. This is reverse indexed, with @everyone being 0.
    ServerId string
    Which server the role will be in.
    Color float64
    Integer representation of the role color with decimal color code.
    Hoist bool
    Whether the role should be hoisted. (default false)
    Managed bool
    Whether this role is managed by another service.
    Mentionable bool
    Whether the role should be mentionable. (default false)
    Name string
    Name of the role.
    Permissions float64
    Permission bits of the role.
    Position float64
    Position of the role. This is reverse indexed, with @everyone being 0.
    ServerId string
    Which server the role will be in.
    color Double
    Integer representation of the role color with decimal color code.
    hoist Boolean
    Whether the role should be hoisted. (default false)
    managed Boolean
    Whether this role is managed by another service.
    mentionable Boolean
    Whether the role should be mentionable. (default false)
    name String
    Name of the role.
    permissions Double
    Permission bits of the role.
    position Double
    Position of the role. This is reverse indexed, with @everyone being 0.
    serverId String
    Which server the role will be in.
    color number
    Integer representation of the role color with decimal color code.
    hoist boolean
    Whether the role should be hoisted. (default false)
    managed boolean
    Whether this role is managed by another service.
    mentionable boolean
    Whether the role should be mentionable. (default false)
    name string
    Name of the role.
    permissions number
    Permission bits of the role.
    position number
    Position of the role. This is reverse indexed, with @everyone being 0.
    serverId string
    Which server the role will be in.
    color float
    Integer representation of the role color with decimal color code.
    hoist bool
    Whether the role should be hoisted. (default false)
    managed bool
    Whether this role is managed by another service.
    mentionable bool
    Whether the role should be mentionable. (default false)
    name str
    Name of the role.
    permissions float
    Permission bits of the role.
    position float
    Position of the role. This is reverse indexed, with @everyone being 0.
    server_id str
    Which server the role will be in.
    color Number
    Integer representation of the role color with decimal color code.
    hoist Boolean
    Whether the role should be hoisted. (default false)
    managed Boolean
    Whether this role is managed by another service.
    mentionable Boolean
    Whether the role should be mentionable. (default false)
    name String
    Name of the role.
    permissions Number
    Permission bits of the role.
    position Number
    Position of the role. This is reverse indexed, with @everyone being 0.
    serverId String
    Which server the role will be in.

    Import

    $ pulumi import discord:index/role:Role example "<server id>:<role id>"

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

    Package Details

    Repository
    discord lucky3028/terraform-provider-discord
    License
    Notes
    This Pulumi package is based on the discord Terraform Provider.
    discord logo
    discord 2.0.0 published on Friday, Mar 7, 2025 by lucky3028
    lucky3028/terraform-provider-discord