Package com.pulumi.aws.ivs

Class Channel

  • public class Channel
extends com.pulumi.resources.CustomResource
    Resource for managing an AWS IVS (Interactive Video) Channel. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.ivs.Channel;
 import com.pulumi.aws.ivs.ChannelArgs;
 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 Channel("example", ChannelArgs.builder()
             .name("channel-1")
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required - `arn` (String) ARN of the IVS channel. Using `pulumi import`, import IVS (Interactive Video) Channel using the ARN. For example: ```sh $ pulumi import aws:ivs/channel:Channel example arn:aws:ivs:us-west-2:326937407773:channel/0Y1lcs4U7jk5 ```

    • 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
      Channel​(java.lang.String name)  
      Channel​(java.lang.String name, ChannelArgs args)  
      Channel​(java.lang.String name, ChannelArgs 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()  
      com.pulumi.core.Output<java.lang.Boolean> authorized()  
      static Channel get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ChannelState 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.lang.String> ingestEndpoint()  
      com.pulumi.core.Output<java.lang.String> latencyMode()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> playbackUrl()  
      com.pulumi.core.Output<java.lang.String> recordingConfigurationArn()  
      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()  
      com.pulumi.core.Output<java.lang.String> type()  

      • 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

      • Channel

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

      • Channel

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

      • Channel

        public Channel​(java.lang.String name,
               @Nullable
               ChannelArgs 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 Channel.

      • authorized

        public com.pulumi.core.Output<java.lang.Boolean> authorized()
        Returns:
        If `true`, channel is private (enabled for playback authorization).

      • ingestEndpoint

        public com.pulumi.core.Output<java.lang.String> ingestEndpoint()
        Returns:
        Channel ingest endpoint, part of the definition of an ingest server, used when setting up streaming software.

      • latencyMode

        public com.pulumi.core.Output<java.lang.String> latencyMode()
        Returns:
        Channel latency mode. Valid values: `NORMAL`, `LOW`.

      • name

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

      • playbackUrl

        public com.pulumi.core.Output<java.lang.String> playbackUrl()
        Returns:
        Channel playback URL.

      • recordingConfigurationArn

        public com.pulumi.core.Output<java.lang.String> recordingConfigurationArn()
        Returns:
        Recording configuration ARN.

      • 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.

      • type

        public com.pulumi.core.Output<java.lang.String> type()
        Returns:
        Channel type, which determines the allowable resolution and bitrate. Valid values: `STANDARD`, `BASIC`.

      • get

        public static Channel get​(java.lang.String name,
                          com.pulumi.core.Output<java.lang.String> id,
                          @Nullable
                          ChannelState 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.