Room class
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")
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 main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ivschat_room" "example" {
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.ArrayList;
import java.util.Arrays;
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
Required
arn(String) ARN of the IVS Chat room.
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
Constructors
- Room(String name, {RoomArgs? args, CustomResourceOptions? options})
-
Creates a new Room.
nameThe Pulumi resource name.argsArguments used to configure this Room. The set of arguments for Room.optionsResource options controlling this resource's behavior. - Room.reference(String urn)
- Creates a typed reference to an existing Room resource.
Properties
-
arn
↔ Output<
String> -
ARN of the Room.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
loggingConfigurationIdentifiers
↔ Output<
List< String> ?> -
List of Logging Configuration
ARNs to attach to the room.
latefinal
-
maximumMessageLength
↔ Output<
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.
latefinal
-
maximumMessageRatePerSecond
↔ Output<
int> -
Maximum number of messages per
second that can be sent to the room (by all clients).
latefinal
-
messageReviewHandler
↔ Output<
RoomMessageReviewHandler?> -
Configuration information for optional
review of messages.
latefinal
-
name
↔ Output<
String> -
Room name.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
A map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited