Package com.pulumi.aws.ivschat

Class Room

  • public class Room
extends com.pulumi.resources.CustomResource
    Resource for managing an AWS IVS (Interactive Video) Chat Room. ## Example Usage ### Basic Usage 
     
 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());
 
     }
 }
    #### Required - `arn` (String) ARN of the IVS Chat room. Using `pulumi import`, import IVS (Interactive Video) Chat Room using the ARN. For example: ```sh $ pulumi import aws:ivschat/room:Room example arn:aws:ivschat:us-west-2:326937407773:room/GoXEXyB4VwHb ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Room​(java.lang.String name)  
      Room​(java.lang.String name, RoomArgs args)  
      Room​(java.lang.String name, RoomArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      static Room get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, RoomState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> loggingConfigurationIdentifiers()  
      com.pulumi.core.Output<java.lang.Integer> maximumMessageLength()  
      com.pulumi.core.Output<java.lang.Integer> maximumMessageRatePerSecond()  
      com.pulumi.core.Output<java.util.Optional<RoomMessageReviewHandler>> messageReviewHandler()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Room

        public Room​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Room

        public Room​(java.lang.String name,
            @Nullable
            RoomArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Room

        public Room​(java.lang.String name,
            @Nullable
            RoomArgs args,
            @Nullable
            com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the Room.

      • loggingConfigurationIdentifiers

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> loggingConfigurationIdentifiers()
        Returns:
        List of Logging Configuration ARNs to attach to the room.

      • maximumMessageLength

        public com.pulumi.core.Output<java.lang.Integer> maximumMessageLength()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.Integer> maximumMessageRatePerSecond()
        Returns:
        Maximum number of messages per second that can be sent to the room (by all clients).

      • messageReviewHandler

        public com.pulumi.core.Output<java.util.Optional<RoomMessageReviewHandler>> messageReviewHandler()
        Returns:
        Configuration information for optional review of messages.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Room name.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • get

        public static Room get​(java.lang.String name,
                       com.pulumi.core.Output<java.lang.String> id,
                       @Nullable
                       RoomState state,
                       @Nullable
                       com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.