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

discord.SystemChannel

Explore with Pulumi AI

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

    Manage the system channel of a Discord server.

    Example Usage

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

const systemTextChannel = new discord.TextChannel("systemTextChannel", {serverId: _var.server_id});
const systemSystemChannel = new discord.SystemChannel("systemSystemChannel", {
    serverId: systemTextChannel.serverId,
    systemChannelId: systemTextChannel.id,
});

    import pulumi
import pulumi_discord as discord

system_text_channel = discord.TextChannel("systemTextChannel", server_id=var["server_id"])
system_system_channel = discord.SystemChannel("systemSystemChannel",
    server_id=system_text_channel.server_id,
    system_channel_id=system_text_channel.id)

    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 {
		systemTextChannel, err := discord.NewTextChannel(ctx, "systemTextChannel", &discord.TextChannelArgs{
			ServerId: pulumi.Any(_var.Server_id),
		})
		if err != nil {
			return err
		}
		_, err = discord.NewSystemChannel(ctx, "systemSystemChannel", &discord.SystemChannelArgs{
			ServerId:        systemTextChannel.ServerId,
			SystemChannelId: systemTextChannel.ID(),
		})
		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 systemTextChannel = new Discord.TextChannel("systemTextChannel", new()
    {
        ServerId = @var.Server_id,
    });

    var systemSystemChannel = new Discord.SystemChannel("systemSystemChannel", new()
    {
        ServerId = systemTextChannel.ServerId,
        SystemChannelId = systemTextChannel.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.discord.TextChannel;
import com.pulumi.discord.TextChannelArgs;
import com.pulumi.discord.SystemChannel;
import com.pulumi.discord.SystemChannelArgs;
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 systemTextChannel = new TextChannel("systemTextChannel", TextChannelArgs.builder()
            .serverId(var_.server_id())
            .build());

        var systemSystemChannel = new SystemChannel("systemSystemChannel", SystemChannelArgs.builder()
            .serverId(systemTextChannel.serverId())
            .systemChannelId(systemTextChannel.id())
            .build());

    }
}

    resources:
  systemTextChannel:
    type: discord:TextChannel
    properties:
      serverId: ${var.server_id}
  systemSystemChannel:
    type: discord:SystemChannel
    properties:
      serverId: ${systemTextChannel.serverId}
      systemChannelId: ${systemTextChannel.id}

    Create SystemChannel Resource

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

    Constructor syntax

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

@overload
def SystemChannel(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  server_id: Optional[str] = None,
                  system_channel_id: Optional[str] = None)
    func NewSystemChannel(ctx *Context, name string, args SystemChannelArgs, opts ...ResourceOption) (*SystemChannel, error)
    public SystemChannel(string name, SystemChannelArgs args, CustomResourceOptions? opts = null)
    public SystemChannel(String name, SystemChannelArgs args)
public SystemChannel(String name, SystemChannelArgs args, CustomResourceOptions options)

    type: discord:SystemChannel
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 SystemChannelArgs
    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 SystemChannelArgs
    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 SystemChannelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SystemChannelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SystemChannelArgs
    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 systemChannelResource = new Discord.SystemChannel("systemChannelResource", new()
{
    ServerId = "string",
    SystemChannelId = "string",
});

    example, err := discord.NewSystemChannel(ctx, "systemChannelResource", &discord.SystemChannelArgs{
ServerId: pulumi.String("string"),
SystemChannelId: pulumi.String("string"),
})

    var systemChannelResource = new SystemChannel("systemChannelResource", SystemChannelArgs.builder()
    .serverId("string")
    .systemChannelId("string")
    .build());

    system_channel_resource = discord.SystemChannel("systemChannelResource",
    server_id="string",
    system_channel_id="string")

    const systemChannelResource = new discord.SystemChannel("systemChannelResource", {
    serverId: "string",
    systemChannelId: "string",
});

    type: discord:SystemChannel
properties:
    serverId: string
    systemChannelId: string

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

    ServerId string
    The ID of the server to manage the system channel for.
    SystemChannelId string
    The ID of the channel that will be used as the system channel.
    ServerId string
    The ID of the server to manage the system channel for.
    SystemChannelId string
    The ID of the channel that will be used as the system channel.
    serverId String
    The ID of the server to manage the system channel for.
    systemChannelId String
    The ID of the channel that will be used as the system channel.
    serverId string
    The ID of the server to manage the system channel for.
    systemChannelId string
    The ID of the channel that will be used as the system channel.
    server_id str
    The ID of the server to manage the system channel for.
    system_channel_id str
    The ID of the channel that will be used as the system channel.
    serverId String
    The ID of the server to manage the system channel for.
    systemChannelId String
    The ID of the channel that will be used as the system channel.

    Outputs

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

    Get an existing SystemChannel 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?: SystemChannelState, opts?: CustomResourceOptions): SystemChannel
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        server_id: Optional[str] = None,
        system_channel_id: Optional[str] = None) -> SystemChannel
    func GetSystemChannel(ctx *Context, name string, id IDInput, state *SystemChannelState, opts ...ResourceOption) (*SystemChannel, error)
    public static SystemChannel Get(string name, Input<string> id, SystemChannelState? state, CustomResourceOptions? opts = null)
    public static SystemChannel get(String name, Output<String> id, SystemChannelState state, CustomResourceOptions options)
    resources:  _:    type: discord:SystemChannel    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:
    ServerId string
    The ID of the server to manage the system channel for.
    SystemChannelId string
    The ID of the channel that will be used as the system channel.
    ServerId string
    The ID of the server to manage the system channel for.
    SystemChannelId string
    The ID of the channel that will be used as the system channel.
    serverId String
    The ID of the server to manage the system channel for.
    systemChannelId String
    The ID of the channel that will be used as the system channel.
    serverId string
    The ID of the server to manage the system channel for.
    systemChannelId string
    The ID of the channel that will be used as the system channel.
    server_id str
    The ID of the server to manage the system channel for.
    system_channel_id str
    The ID of the channel that will be used as the system channel.
    serverId String
    The ID of the server to manage the system channel for.
    systemChannelId String
    The ID of the channel that will be used as the system channel.

    Import

    $ pulumi import discord:index/systemChannel:SystemChannel example "<channel 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