discord 2.1.0, Jul 4 25

discord 2.1.0 published on Friday, Jul 4, 2025 by lucky3028

discord.ForumChannel

Explore with Pulumi AI

discord 2.1.0 published on Friday, Jul 4, 2025 by lucky3028

Create ForumChannel Resource

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

Constructor syntax

new ForumChannel(name: string, args: ForumChannelArgs, opts?: CustomResourceOptions);

@overload
def ForumChannel(resource_name: str,
                 args: ForumChannelArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def ForumChannel(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 server_id: Optional[str] = None,
                 category: Optional[str] = None,
                 name: Optional[str] = None,
                 nsfw: Optional[bool] = None,
                 position: Optional[float] = None,
                 sync_perms_with_category: Optional[bool] = None,
                 topic: Optional[str] = None,
                 type: Optional[str] = None)

func NewForumChannel(ctx *Context, name string, args ForumChannelArgs, opts ...ResourceOption) (*ForumChannel, error)

public ForumChannel(string name, ForumChannelArgs args, CustomResourceOptions? opts = null)

public ForumChannel(String name, ForumChannelArgs args)
public ForumChannel(String name, ForumChannelArgs args, CustomResourceOptions options)

type: discord:ForumChannel
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 ForumChannelArgs: 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 ForumChannelArgs: 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 ForumChannelArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ForumChannelArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ForumChannelArgs: 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 forumChannelResource = new Discord.ForumChannel("forumChannelResource", new()
{
    ServerId = "string",
    Category = "string",
    Name = "string",
    Nsfw = false,
    Position = 0,
    SyncPermsWithCategory = false,
    Topic = "string",
    Type = "string",
});

example, err := discord.NewForumChannel(ctx, "forumChannelResource", &discord.ForumChannelArgs{
	ServerId:              pulumi.String("string"),
	Category:              pulumi.String("string"),
	Name:                  pulumi.String("string"),
	Nsfw:                  pulumi.Bool(false),
	Position:              pulumi.Float64(0),
	SyncPermsWithCategory: pulumi.Bool(false),
	Topic:                 pulumi.String("string"),
	Type:                  pulumi.String("string"),
})

var forumChannelResource = new ForumChannel("forumChannelResource", ForumChannelArgs.builder()
    .serverId("string")
    .category("string")
    .name("string")
    .nsfw(false)
    .position(0.0)
    .syncPermsWithCategory(false)
    .topic("string")
    .type("string")
    .build());

forum_channel_resource = discord.ForumChannel("forumChannelResource",
    server_id="string",
    category="string",
    name="string",
    nsfw=False,
    position=0,
    sync_perms_with_category=False,
    topic="string",
    type="string")

const forumChannelResource = new discord.ForumChannel("forumChannelResource", {
    serverId: "string",
    category: "string",
    name: "string",
    nsfw: false,
    position: 0,
    syncPermsWithCategory: false,
    topic: "string",
    type: "string",
});

type: discord:ForumChannel
properties:
    category: string
    name: string
    nsfw: false
    position: 0
    serverId: string
    syncPermsWithCategory: false
    topic: string
    type: string

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

ServerId string: ID of server this channel is in.
Category string: ID of category to place this channel in.
Name string: Name of the channel.
Nsfw bool: Whether the channel is NSFW.
Position double: Position of the channel, 0-indexed.
SyncPermsWithCategory bool: Whether channel permissions should be synced with the category this channel is in.
Topic string: Topic of the channel.
Type string: The type of the channel. This is only for internal use and should never be provided.

ServerId string: ID of server this channel is in.
Category string: ID of category to place this channel in.
Name string: Name of the channel.
Nsfw bool: Whether the channel is NSFW.
Position float64: Position of the channel, 0-indexed.
SyncPermsWithCategory bool: Whether channel permissions should be synced with the category this channel is in.
Topic string: Topic of the channel.
Type string: The type of the channel. This is only for internal use and should never be provided.

serverId String: ID of server this channel is in.
category String: ID of category to place this channel in.
name String: Name of the channel.
nsfw Boolean: Whether the channel is NSFW.
position Double: Position of the channel, 0-indexed.
syncPermsWithCategory Boolean: Whether channel permissions should be synced with the category this channel is in.
topic String: Topic of the channel.
type String: The type of the channel. This is only for internal use and should never be provided.

serverId string: ID of server this channel is in.
category string: ID of category to place this channel in.
name string: Name of the channel.
nsfw boolean: Whether the channel is NSFW.
position number: Position of the channel, 0-indexed.
syncPermsWithCategory boolean: Whether channel permissions should be synced with the category this channel is in.
topic string: Topic of the channel.
type string: The type of the channel. This is only for internal use and should never be provided.

server_id str: ID of server this channel is in.
category str: ID of category to place this channel in.
name str: Name of the channel.
nsfw bool: Whether the channel is NSFW.
position float: Position of the channel, 0-indexed.
sync_perms_with_category bool: Whether channel permissions should be synced with the category this channel is in.
topic str: Topic of the channel.
type str: The type of the channel. This is only for internal use and should never be provided.

serverId String: ID of server this channel is in.
category String: ID of category to place this channel in.
name String: Name of the channel.
nsfw Boolean: Whether the channel is NSFW.
position Number: Position of the channel, 0-indexed.
syncPermsWithCategory Boolean: Whether channel permissions should be synced with the category this channel is in.
topic String: Topic of the channel.
type String: The type of the channel. This is only for internal use and should never be provided.

Outputs

All input properties are implicitly available as output properties. Additionally, the ForumChannel resource produces the following output properties:

ChannelId string: The ID of the channel.
Id string: The provider-assigned unique ID for this managed resource.

ChannelId string: The ID of the channel.
Id string: The provider-assigned unique ID for this managed resource.

channelId String: The ID of the channel.
id String: The provider-assigned unique ID for this managed resource.

channelId string: The ID of the channel.
id string: The provider-assigned unique ID for this managed resource.

channel_id str: The ID of the channel.
id str: The provider-assigned unique ID for this managed resource.

channelId String: The ID of the channel.
id String: The provider-assigned unique ID for this managed resource.

Look up Existing ForumChannel Resource

Get an existing ForumChannel 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?: ForumChannelState, opts?: CustomResourceOptions): ForumChannel

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        category: Optional[str] = None,
        channel_id: Optional[str] = None,
        name: Optional[str] = None,
        nsfw: Optional[bool] = None,
        position: Optional[float] = None,
        server_id: Optional[str] = None,
        sync_perms_with_category: Optional[bool] = None,
        topic: Optional[str] = None,
        type: Optional[str] = None) -> ForumChannel

func GetForumChannel(ctx *Context, name string, id IDInput, state *ForumChannelState, opts ...ResourceOption) (*ForumChannel, error)

public static ForumChannel Get(string name, Input<string> id, ForumChannelState? state, CustomResourceOptions? opts = null)

public static ForumChannel get(String name, Output<String> id, ForumChannelState state, CustomResourceOptions options)

resources:  _:    type: discord:ForumChannel    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:

Category string: ID of category to place this channel in.
ChannelId string: The ID of the channel.
Name string: Name of the channel.
Nsfw bool: Whether the channel is NSFW.
Position double: Position of the channel, 0-indexed.
ServerId string: ID of server this channel is in.
SyncPermsWithCategory bool: Whether channel permissions should be synced with the category this channel is in.
Topic string: Topic of the channel.
Type string: The type of the channel. This is only for internal use and should never be provided.

Category string: ID of category to place this channel in.
ChannelId string: The ID of the channel.
Name string: Name of the channel.
Nsfw bool: Whether the channel is NSFW.
Position float64: Position of the channel, 0-indexed.
ServerId string: ID of server this channel is in.
SyncPermsWithCategory bool: Whether channel permissions should be synced with the category this channel is in.
Topic string: Topic of the channel.
Type string: The type of the channel. This is only for internal use and should never be provided.

category String: ID of category to place this channel in.
channelId String: The ID of the channel.
name String: Name of the channel.
nsfw Boolean: Whether the channel is NSFW.
position Double: Position of the channel, 0-indexed.
serverId String: ID of server this channel is in.
syncPermsWithCategory Boolean: Whether channel permissions should be synced with the category this channel is in.
topic String: Topic of the channel.
type String: The type of the channel. This is only for internal use and should never be provided.

category string: ID of category to place this channel in.
channelId string: The ID of the channel.
name string: Name of the channel.
nsfw boolean: Whether the channel is NSFW.
position number: Position of the channel, 0-indexed.
serverId string: ID of server this channel is in.
syncPermsWithCategory boolean: Whether channel permissions should be synced with the category this channel is in.
topic string: Topic of the channel.
type string: The type of the channel. This is only for internal use and should never be provided.

category str: ID of category to place this channel in.
channel_id str: The ID of the channel.
name str: Name of the channel.
nsfw bool: Whether the channel is NSFW.
position float: Position of the channel, 0-indexed.
server_id str: ID of server this channel is in.
sync_perms_with_category bool: Whether channel permissions should be synced with the category this channel is in.
topic str: Topic of the channel.
type str: The type of the channel. This is only for internal use and should never be provided.

category String: ID of category to place this channel in.
channelId String: The ID of the channel.
name String: Name of the channel.
nsfw Boolean: Whether the channel is NSFW.
position Number: Position of the channel, 0-indexed.
serverId String: ID of server this channel is in.
syncPermsWithCategory Boolean: Whether channel permissions should be synced with the category this channel is in.
topic String: Topic of the channel.
type String: The type of the channel. This is only for internal use and should never be provided.

Package Details

Repository: discord lucky3028/terraform-provider-discord
License
Notes: This Pulumi package is based on the discord Terraform Provider.

discord 2.1.0 published on Friday, Jul 4, 2025 by lucky3028

lucky3028/terraform-provider-discord

discord.ForumChannel

On this page

On this page

Create ForumChannel Resource

Constructor syntax

Parameters

Constructor example

ForumChannel Resource Properties

Inputs

Outputs

Look up Existing ForumChannel Resource

Package Details

On this page

On this page