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

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

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.ivschat.getRoom

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

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

    Using getRoom

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRoom(args: GetRoomArgs, opts?: InvokeOptions): Promise<GetRoomResult>
function getRoomOutput(args: GetRoomOutputArgs, opts?: InvokeOptions): Output<GetRoomResult>
    def get_room(arn: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetRoomResult
def get_room_output(arn: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetRoomResult]
    func LookupRoom(ctx *Context, args *LookupRoomArgs, opts ...InvokeOption) (*LookupRoomResult, error)
func LookupRoomOutput(ctx *Context, args *LookupRoomOutputArgs, opts ...InvokeOption) LookupRoomResultOutput

    > Note: This function is named LookupRoom in the Go SDK.

    public static class GetRoom 
{
    public static Task<GetRoomResult> InvokeAsync(GetRoomArgs args, InvokeOptions? opts = null)
    public static Output<GetRoomResult> Invoke(GetRoomInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRoomResult> getRoom(GetRoomArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:ivschat:getRoom
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    Room ARN is automatically generated on creation and assigned as the unique identifier.
    Arn string
    Room ARN is automatically generated on creation and assigned as the unique identifier.
    arn String
    Room ARN is automatically generated on creation and assigned as the unique identifier.
    arn string
    Room ARN is automatically generated on creation and assigned as the unique identifier.
    arn str
    Room ARN is automatically generated on creation and assigned as the unique identifier.
    arn String
    Room ARN is automatically generated on creation and assigned as the unique identifier.

    getRoom Result

    The following output properties are available:

    Arn string
    Room ARN is automatically generated on creation and assigned as the unique identifier.
    Id string
    The system-generated ID of the room.
    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.Outputs.RoomMessageReviewHandler
    Configuration information for optional review of messages.
    Name string
    The name of the room. The value does not need to be unique.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    Arn string
    Room ARN is automatically generated on creation and assigned as the unique identifier.
    Id string
    The system-generated ID of the room.
    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 RoomMessageReviewHandler
    Configuration information for optional review of messages.
    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.
    arn String
    Room ARN is automatically generated on creation and assigned as the unique identifier.
    id String
    The system-generated ID of the room.
    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
    Configuration information for optional review of messages.
    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.
    arn string
    Room ARN is automatically generated on creation and assigned as the unique identifier.
    id string
    The system-generated ID of the room.
    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
    Configuration information for optional review of messages.
    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.
    arn str
    Room ARN is automatically generated on creation and assigned as the unique identifier.
    id str
    The system-generated ID of the room.
    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 RoomMessageReviewHandler
    Configuration information for optional review of messages.
    name str
    The name of the room. The value does not need to be unique.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    arn String
    Room ARN is automatically generated on creation and assigned as the unique identifier.
    id String
    The system-generated ID of the room.
    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
    Configuration information for optional review of messages.
    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.

    Supporting Types

    RoomMessageReviewHandler

    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

    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 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.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native