Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. ivschat
  5. Room

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.ivschat.Room

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource type definition for AWS::IVSChat::Room.

    Example Usage

    Example

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

return await Deployment.RunAsync(() => 
{
    var room = new AwsNative.IvsChat.Room("room", new()
    {
        Name = "MyRoom",
        Tags = new[]
        {
            new AwsNative.Inputs.TagArgs
            {
                Key = "MyKey",
                Value = "MyValue",
            },
        },
    });

    return new Dictionary<string, object?>
    {
        ["roomArn"] = room.Id,
        ["roomId"] = room.Id,
    };
});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		room, err := ivschat.NewRoom(ctx, "room", &ivschat.RoomArgs{
			Name: pulumi.String("MyRoom"),
			Tags: aws.TagArray{
				&aws.TagArgs{
					Key:   pulumi.String("MyKey"),
					Value: pulumi.String("MyValue"),
				},
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("roomArn", room.ID())
		ctx.Export("roomId", room.ID())
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

room = aws_native.ivschat.Room("room",
    name="MyRoom",
    tags=[aws_native.TagArgs(
        key="MyKey",
        value="MyValue",
    )])
pulumi.export("roomArn", room.id)
pulumi.export("roomId", room.id)

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const room = new aws_native.ivschat.Room("room", {
    name: "MyRoom",
    tags: [{
        key: "MyKey",
        value: "MyValue",
    }],
});
export const roomArn = room.id;
export const roomId = room.id;

    Coming soon!

    Example

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

return await Deployment.RunAsync(() => 
{
    var room = new AwsNative.IvsChat.Room("room", new()
    {
        Name = "MyRoom",
        Tags = new[]
        {
            new AwsNative.Inputs.TagArgs
            {
                Key = "MyKey",
                Value = "MyValue",
            },
        },
    });

    return new Dictionary<string, object?>
    {
        ["roomArn"] = room.Id,
        ["roomId"] = room.Id,
    };
});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		room, err := ivschat.NewRoom(ctx, "room", &ivschat.RoomArgs{
			Name: pulumi.String("MyRoom"),
			Tags: aws.TagArray{
				&aws.TagArgs{
					Key:   pulumi.String("MyKey"),
					Value: pulumi.String("MyValue"),
				},
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("roomArn", room.ID())
		ctx.Export("roomId", room.ID())
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

room = aws_native.ivschat.Room("room",
    name="MyRoom",
    tags=[aws_native.TagArgs(
        key="MyKey",
        value="MyValue",
    )])
pulumi.export("roomArn", room.id)
pulumi.export("roomId", room.id)

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const room = new aws_native.ivschat.Room("room", {
    name: "MyRoom",
    tags: [{
        key: "MyKey",
        value: "MyValue",
    }],
});
export const roomArn = room.id;
export const roomId = room.id;

    Coming soon!

    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[Sequence[_root_inputs.TagArgs]] = 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-native: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.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

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

    Coming soon!

    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

    The Room resource accepts the following input properties:

    LoggingConfigurationIdentifiers List<string>
    Array of logging configuration identifiers attached to the room.
    MaximumMessageLength int
    The maximum number of characters in a single message.
    MaximumMessageRatePerSecond int
    The maximum number of messages per second that can be sent to the room.
    MessageReviewHandler Pulumi.AwsNative.IvsChat.Inputs.RoomMessageReviewHandler
    Name string
    The name of the room. The value does not need to be unique.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    LoggingConfigurationIdentifiers []string
    Array of logging configuration identifiers attached to the room.
    MaximumMessageLength int
    The maximum number of characters in a single message.
    MaximumMessageRatePerSecond int
    The maximum number of messages per second that can be sent to the room.
    MessageReviewHandler RoomMessageReviewHandlerArgs
    Name string
    The name of the room. The value does not need to be unique.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    loggingConfigurationIdentifiers List<String>
    Array of logging configuration identifiers attached to the room.
    maximumMessageLength Integer
    The maximum number of characters in a single message.
    maximumMessageRatePerSecond Integer
    The maximum number of messages per second that can be sent to the room.
    messageReviewHandler RoomMessageReviewHandler
    name String
    The name of the room. The value does not need to be unique.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    loggingConfigurationIdentifiers string[]
    Array of logging configuration identifiers attached to the room.
    maximumMessageLength number
    The maximum number of characters in a single message.
    maximumMessageRatePerSecond number
    The maximum number of messages per second that can be sent to the room.
    messageReviewHandler RoomMessageReviewHandler
    name string
    The name of the room. The value does not need to be unique.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    logging_configuration_identifiers Sequence[str]
    Array of logging configuration identifiers attached to the room.
    maximum_message_length int
    The maximum number of characters in a single message.
    maximum_message_rate_per_second int
    The maximum number of messages per second that can be sent to the room.
    message_review_handler RoomMessageReviewHandlerArgs
    name str
    The name of the room. The value does not need to be unique.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    loggingConfigurationIdentifiers List<String>
    Array of logging configuration identifiers attached to the room.
    maximumMessageLength Number
    The maximum number of characters in a single message.
    maximumMessageRatePerSecond Number
    The maximum number of messages per second that can be sent to the room.
    messageReviewHandler Property Map
    name String
    The name of the room. The value does not need to be unique.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Outputs

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

    Arn string
    Room ARN is automatically generated on creation and assigned as the unique identifier.
    AwsId string
    The system-generated ID of the room.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    Room ARN is automatically generated on creation and assigned as the unique identifier.
    AwsId string
    The system-generated ID of the room.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    Room ARN is automatically generated on creation and assigned as the unique identifier.
    awsId String
    The system-generated ID of the room.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    Room ARN is automatically generated on creation and assigned as the unique identifier.
    awsId string
    The system-generated ID of the room.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    Room ARN is automatically generated on creation and assigned as the unique identifier.
    aws_id str
    The system-generated ID of the room.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    Room ARN is automatically generated on creation and assigned as the unique identifier.
    awsId String
    The system-generated ID of the room.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    RoomMessageReviewHandler, RoomMessageReviewHandlerArgs

    FallbackResult Pulumi.AwsNative.IvsChat.RoomMessageReviewHandlerFallbackResult
    Specifies the fallback behavior if the handler does not return a valid response, encounters an error, or times out.
    Uri string
    Identifier of the message review handler.
    FallbackResult RoomMessageReviewHandlerFallbackResult
    Specifies the fallback behavior if the handler does not return a valid response, encounters an error, or times out.
    Uri string
    Identifier of the message review handler.
    fallbackResult RoomMessageReviewHandlerFallbackResult
    Specifies the fallback behavior if the handler does not return a valid response, encounters an error, or times out.
    uri String
    Identifier of the message review handler.
    fallbackResult RoomMessageReviewHandlerFallbackResult
    Specifies the fallback behavior if the handler does not return a valid response, encounters an error, or times out.
    uri string
    Identifier of the message review handler.
    fallback_result RoomMessageReviewHandlerFallbackResult
    Specifies the fallback behavior if the handler does not return a valid response, encounters an error, or times out.
    uri str
    Identifier of the message review handler.
    fallbackResult "ALLOW" | "DENY"
    Specifies the fallback behavior if the handler does not return a valid response, encounters an error, or times out.
    uri String
    Identifier of the message review handler.

    RoomMessageReviewHandlerFallbackResult, RoomMessageReviewHandlerFallbackResultArgs

    Allow
    ALLOW
    Deny
    DENY
    RoomMessageReviewHandlerFallbackResultAllow
    ALLOW
    RoomMessageReviewHandlerFallbackResultDeny
    DENY
    Allow
    ALLOW
    Deny
    DENY
    Allow
    ALLOW
    Deny
    DENY
    ALLOW
    ALLOW
    DENY
    DENY
    "ALLOW"
    ALLOW
    "DENY"
    DENY

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
    pulumi/pulumi-aws-native