Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. ivschat
  5. Room
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.ivschat.Room

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Resource for managing an AWS IVS (Interactive Video) Chat Room.

    Example Usage

    Basic Usage

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

const example = new aws.ivschat.Room("example", {name: "tf-room"});

    import pulumi
import pulumi_aws as aws

example = aws.ivschat.Room("example", name="tf-room")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ivschat"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ivschat.NewRoom(ctx, "example", &ivschat.RoomArgs{
			Name: pulumi.String("tf-room"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Aws.IvsChat.Room("example", new()
    {
        Name = "tf-room",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ivschat.Room;
import com.pulumi.aws.ivschat.RoomArgs;
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 example = new Room("example", RoomArgs.builder()
            .name("tf-room")
            .build());

    }
}

    resources:
  example:
    type: aws:ivschat:Room
    properties:
      name: tf-room

    Create Room Resource

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

    Constructor syntax

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

@overload
def Room(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         logging_configuration_identifiers: Optional[Sequence[str]] = None,
         maximum_message_length: Optional[int] = None,
         maximum_message_rate_per_second: Optional[int] = None,
         message_review_handler: Optional[RoomMessageReviewHandlerArgs] = None,
         name: Optional[str] = None,
         tags: Optional[Mapping[str, str]] = None)
    func NewRoom(ctx *Context, name string, args *RoomArgs, opts ...ResourceOption) (*Room, error)
    public Room(string name, RoomArgs? args = null, CustomResourceOptions? opts = null)
    public Room(String name, RoomArgs args)
public Room(String name, RoomArgs args, CustomResourceOptions options)

    type: aws:ivschat:Room
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 RoomArgs
    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 RoomArgs
    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 RoomArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RoomArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RoomArgs
    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 roomResource = new Aws.IvsChat.Room("roomResource", new()
{
    LoggingConfigurationIdentifiers = new[]
    {
        "string",
    },
    MaximumMessageLength = 0,
    MaximumMessageRatePerSecond = 0,
    MessageReviewHandler = new Aws.IvsChat.Inputs.RoomMessageReviewHandlerArgs
    {
        FallbackResult = "string",
        Uri = "string",
    },
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := ivschat.NewRoom(ctx, "roomResource", &ivschat.RoomArgs{
	LoggingConfigurationIdentifiers: pulumi.StringArray{
		pulumi.String("string"),
	},
	MaximumMessageLength:        pulumi.Int(0),
	MaximumMessageRatePerSecond: pulumi.Int(0),
	MessageReviewHandler: &ivschat.RoomMessageReviewHandlerArgs{
		FallbackResult: pulumi.String("string"),
		Uri:            pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var roomResource = new Room("roomResource", RoomArgs.builder()
    .loggingConfigurationIdentifiers("string")
    .maximumMessageLength(0)
    .maximumMessageRatePerSecond(0)
    .messageReviewHandler(RoomMessageReviewHandlerArgs.builder()
        .fallbackResult("string")
        .uri("string")
        .build())
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    room_resource = aws.ivschat.Room("roomResource",
    logging_configuration_identifiers=["string"],
    maximum_message_length=0,
    maximum_message_rate_per_second=0,
    message_review_handler={
        "fallback_result": "string",
        "uri": "string",
    },
    name="string",
    tags={
        "string": "string",
    })

    const roomResource = new aws.ivschat.Room("roomResource", {
    loggingConfigurationIdentifiers: ["string"],
    maximumMessageLength: 0,
    maximumMessageRatePerSecond: 0,
    messageReviewHandler: {
        fallbackResult: "string",
        uri: "string",
    },
    name: "string",
    tags: {
        string: "string",
    },
});

    type: aws:ivschat:Room
properties:
    loggingConfigurationIdentifiers:
        - string
    maximumMessageLength: 0
    maximumMessageRatePerSecond: 0
    messageReviewHandler:
        fallbackResult: string
        uri: string
    name: string
    tags:
        string: string

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

    LoggingConfigurationIdentifiers List<string>
    List of Logging Configuration ARNs to attach to the room.
    MaximumMessageLength int
    Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes.
    MaximumMessageRatePerSecond int
    Maximum number of messages per second that can be sent to the room (by all clients).
    MessageReviewHandler RoomMessageReviewHandler
    Configuration information for optional review of messages.
    Name string
    Room name.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    LoggingConfigurationIdentifiers []string
    List of Logging Configuration ARNs to attach to the room.
    MaximumMessageLength int
    Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes.
    MaximumMessageRatePerSecond int
    Maximum number of messages per second that can be sent to the room (by all clients).
    MessageReviewHandler RoomMessageReviewHandlerArgs
    Configuration information for optional review of messages.
    Name string
    Room name.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    loggingConfigurationIdentifiers List<String>
    List of Logging Configuration ARNs to attach to the room.
    maximumMessageLength Integer
    Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes.
    maximumMessageRatePerSecond Integer
    Maximum number of messages per second that can be sent to the room (by all clients).
    messageReviewHandler RoomMessageReviewHandler
    Configuration information for optional review of messages.
    name String
    Room name.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    loggingConfigurationIdentifiers string[]
    List of Logging Configuration ARNs to attach to the room.
    maximumMessageLength number
    Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes.
    maximumMessageRatePerSecond number
    Maximum number of messages per second that can be sent to the room (by all clients).
    messageReviewHandler RoomMessageReviewHandler
    Configuration information for optional review of messages.
    name string
    Room name.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    logging_configuration_identifiers Sequence[str]
    List of Logging Configuration ARNs to attach to the room.
    maximum_message_length int
    Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes.
    maximum_message_rate_per_second int
    Maximum number of messages per second that can be sent to the room (by all clients).
    message_review_handler RoomMessageReviewHandlerArgs
    Configuration information for optional review of messages.
    name str
    Room name.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    loggingConfigurationIdentifiers List<String>
    List of Logging Configuration ARNs to attach to the room.
    maximumMessageLength Number
    Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes.
    maximumMessageRatePerSecond Number
    Maximum number of messages per second that can be sent to the room (by all clients).
    messageReviewHandler Property Map
    Configuration information for optional review of messages.
    name String
    Room name.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    ARN of the Room.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN of the Room.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the Room.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN of the Room.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN of the Room.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the Room.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Room Resource

    Get an existing Room 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?: RoomState, opts?: CustomResourceOptions): Room
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        logging_configuration_identifiers: Optional[Sequence[str]] = None,
        maximum_message_length: Optional[int] = None,
        maximum_message_rate_per_second: Optional[int] = None,
        message_review_handler: Optional[RoomMessageReviewHandlerArgs] = None,
        name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Room
    func GetRoom(ctx *Context, name string, id IDInput, state *RoomState, opts ...ResourceOption) (*Room, error)
    public static Room Get(string name, Input<string> id, RoomState? state, CustomResourceOptions? opts = null)
    public static Room get(String name, Output<String> id, RoomState 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:
    Arn string
    ARN of the Room.
    LoggingConfigurationIdentifiers List<string>
    List of Logging Configuration ARNs to attach to the room.
    MaximumMessageLength int
    Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes.
    MaximumMessageRatePerSecond int
    Maximum number of messages per second that can be sent to the room (by all clients).
    MessageReviewHandler RoomMessageReviewHandler
    Configuration information for optional review of messages.
    Name string
    Room name.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN of the Room.
    LoggingConfigurationIdentifiers []string
    List of Logging Configuration ARNs to attach to the room.
    MaximumMessageLength int
    Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes.
    MaximumMessageRatePerSecond int
    Maximum number of messages per second that can be sent to the room (by all clients).
    MessageReviewHandler RoomMessageReviewHandlerArgs
    Configuration information for optional review of messages.
    Name string
    Room name.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the Room.
    loggingConfigurationIdentifiers List<String>
    List of Logging Configuration ARNs to attach to the room.
    maximumMessageLength Integer
    Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes.
    maximumMessageRatePerSecond Integer
    Maximum number of messages per second that can be sent to the room (by all clients).
    messageReviewHandler RoomMessageReviewHandler
    Configuration information for optional review of messages.
    name String
    Room name.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN of the Room.
    loggingConfigurationIdentifiers string[]
    List of Logging Configuration ARNs to attach to the room.
    maximumMessageLength number
    Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes.
    maximumMessageRatePerSecond number
    Maximum number of messages per second that can be sent to the room (by all clients).
    messageReviewHandler RoomMessageReviewHandler
    Configuration information for optional review of messages.
    name string
    Room name.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN of the Room.
    logging_configuration_identifiers Sequence[str]
    List of Logging Configuration ARNs to attach to the room.
    maximum_message_length int
    Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes.
    maximum_message_rate_per_second int
    Maximum number of messages per second that can be sent to the room (by all clients).
    message_review_handler RoomMessageReviewHandlerArgs
    Configuration information for optional review of messages.
    name str
    Room name.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the Room.
    loggingConfigurationIdentifiers List<String>
    List of Logging Configuration ARNs to attach to the room.
    maximumMessageLength Number
    Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes.
    maximumMessageRatePerSecond Number
    Maximum number of messages per second that can be sent to the room (by all clients).
    messageReviewHandler Property Map
    Configuration information for optional review of messages.
    name String
    Room name.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    RoomMessageReviewHandler, RoomMessageReviewHandlerArgs

    FallbackResult string
    The fallback behavior (whether the message is allowed or denied) if the handler does not return a valid response, encounters an error, or times out. Valid values: ALLOW, DENY.
    Uri string
    ARN of the lambda message review handler function.
    FallbackResult string
    The fallback behavior (whether the message is allowed or denied) if the handler does not return a valid response, encounters an error, or times out. Valid values: ALLOW, DENY.
    Uri string
    ARN of the lambda message review handler function.
    fallbackResult String
    The fallback behavior (whether the message is allowed or denied) if the handler does not return a valid response, encounters an error, or times out. Valid values: ALLOW, DENY.
    uri String
    ARN of the lambda message review handler function.
    fallbackResult string
    The fallback behavior (whether the message is allowed or denied) if the handler does not return a valid response, encounters an error, or times out. Valid values: ALLOW, DENY.
    uri string
    ARN of the lambda message review handler function.
    fallback_result str
    The fallback behavior (whether the message is allowed or denied) if the handler does not return a valid response, encounters an error, or times out. Valid values: ALLOW, DENY.
    uri str
    ARN of the lambda message review handler function.
    fallbackResult String
    The fallback behavior (whether the message is allowed or denied) if the handler does not return a valid response, encounters an error, or times out. Valid values: ALLOW, DENY.
    uri String
    ARN of the lambda message review handler function.

    Import

    Using pulumi import, import IVS (Interactive Video) Chat Room using the ARN. For example:

    $ pulumi import aws:ivschat/room:Room example arn:aws:ivschat:us-west-2:326937407773:room/GoXEXyB4VwHb

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

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws