Package com.pulumi.aws.ivs

Class RecordingConfiguration

  • public class RecordingConfiguration
extends com.pulumi.resources.CustomResource
    Resource for managing an AWS IVS (Interactive Video) Recording Configuration. ## 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.RecordingConfiguration;
 import com.pulumi.aws.ivs.RecordingConfigurationArgs;
 import com.pulumi.aws.ivs.inputs.RecordingConfigurationDestinationConfigurationArgs;
 import com.pulumi.aws.ivs.inputs.RecordingConfigurationDestinationConfigurationS3Args;
 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 RecordingConfiguration("example", RecordingConfigurationArgs.builder()
             .destinationConfiguration(RecordingConfigurationDestinationConfigurationArgs.builder()
                 .s3(RecordingConfigurationDestinationConfigurationS3Args.builder()
                     .bucketName("ivs-stream-archive")
                     .build())
                 .build())
             .name("recording_configuration-1")
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required - `arn` (String) ARN of the IVS recording configuration. Using `pulumi import`, import IVS (Interactive Video) Recording Configuration using the ARN. For example: ```sh $ pulumi import aws:ivs/recordingConfiguration:RecordingConfiguration example arn:aws:ivs:us-west-2:326937407773:recording-configuration/KAk1sHBl2L47 ```

    • 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

    • 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<RecordingConfigurationDestinationConfiguration> destinationConfiguration()  
      static RecordingConfiguration get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, RecordingConfigurationState 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> name()  
      com.pulumi.core.Output<java.lang.Integer> recordingReconnectWindowSeconds()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> state()  
      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<RecordingConfigurationThumbnailConfiguration> thumbnailConfiguration()  

      • 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

      • RecordingConfiguration

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

      • RecordingConfiguration

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

      • RecordingConfiguration

        public RecordingConfiguration​(java.lang.String name,
                              RecordingConfigurationArgs 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 Recording Configuration.

      • name

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

      • recordingReconnectWindowSeconds

        public com.pulumi.core.Output<java.lang.Integer> recordingReconnectWindowSeconds()
        Returns:
        If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.

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

      • state

        public com.pulumi.core.Output<java.lang.String> state()
        Returns:
        The current state of the Recording 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.

      • thumbnailConfiguration

        public com.pulumi.core.Output<RecordingConfigurationThumbnailConfiguration> thumbnailConfiguration()
        Returns:
        Object containing information to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

      • get

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