Package com.pulumi.aws.medialive

Class Channel

  • public class Channel
extends com.pulumi.resources.CustomResource
    Resource for managing an AWS MediaLive 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.medialive.Channel;
 import com.pulumi.aws.medialive.ChannelArgs;
 import com.pulumi.aws.medialive.inputs.ChannelInputSpecificationArgs;
 import com.pulumi.aws.medialive.inputs.ChannelEncoderSettingsArgs;
 import com.pulumi.aws.medialive.inputs.ChannelEncoderSettingsTimecodeConfigArgs;
 import com.pulumi.aws.medialive.inputs.ChannelEncoderSettingsAudioDescriptionArgs;
 import com.pulumi.aws.medialive.inputs.ChannelEncoderSettingsOutputGroupArgs;
 import com.pulumi.aws.medialive.inputs.ChannelEncoderSettingsOutputGroupOutputGroupSettingsArgs;
 import com.pulumi.aws.medialive.inputs.ChannelEncoderSettingsOutputGroupOutputGroupSettingsArchiveGroupSettingArgs;
 import com.pulumi.aws.medialive.inputs.ChannelEncoderSettingsOutputGroupOutputGroupSettingsArchiveGroupSettingDestinationArgs;
 import com.pulumi.aws.medialive.inputs.ChannelEncoderSettingsOutputGroupOutputArgs;
 import com.pulumi.aws.medialive.inputs.ChannelEncoderSettingsOutputGroupOutputOutputSettingsArgs;
 import com.pulumi.aws.medialive.inputs.ChannelEncoderSettingsOutputGroupOutputOutputSettingsArchiveOutputSettingsArgs;
 import com.pulumi.aws.medialive.inputs.ChannelEncoderSettingsOutputGroupOutputOutputSettingsArchiveOutputSettingsContainerSettingsArgs;
 import com.pulumi.aws.medialive.inputs.ChannelEncoderSettingsOutputGroupOutputOutputSettingsArchiveOutputSettingsContainerSettingsM2tsSettingsArgs;
 import com.pulumi.aws.medialive.inputs.ChannelEncoderSettingsVideoDescriptionArgs;
 import com.pulumi.aws.medialive.inputs.ChannelDestinationArgs;
 import com.pulumi.aws.medialive.inputs.ChannelDestinationSettingArgs;
 import com.pulumi.aws.medialive.inputs.ChannelInputAttachmentArgs;
 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()
             .inputSpecification(ChannelInputSpecificationArgs.builder()
                 .codec("AVC")
                 .inputResolution("HD")
                 .maximumBitrate("MAX_20_MBPS")
                 .build())
             .encoderSettings(ChannelEncoderSettingsArgs.builder()
                 .timecodeConfig(ChannelEncoderSettingsTimecodeConfigArgs.builder()
                     .source("EMBEDDED")
                     .build())
                 .audioDescriptions(ChannelEncoderSettingsAudioDescriptionArgs.builder()
                     .audioSelectorName("example audio selector")
                     .name("audio-selector")
                     .build())
                 .outputGroups(ChannelEncoderSettingsOutputGroupArgs.builder()
                     .outputGroupSettings(ChannelEncoderSettingsOutputGroupOutputGroupSettingsArgs.builder()
                         .archiveGroupSettings(ChannelEncoderSettingsOutputGroupOutputGroupSettingsArchiveGroupSettingArgs.builder()
                             .destination(ChannelEncoderSettingsOutputGroupOutputGroupSettingsArchiveGroupSettingDestinationArgs.builder()
                                 .destinationRefId("destination")
                                 .build())
                             .build())
                         .build())
                     .outputs(ChannelEncoderSettingsOutputGroupOutputArgs.builder()
                         .outputSettings(ChannelEncoderSettingsOutputGroupOutputOutputSettingsArgs.builder()
                             .archiveOutputSettings(ChannelEncoderSettingsOutputGroupOutputOutputSettingsArchiveOutputSettingsArgs.builder()
                                 .containerSettings(ChannelEncoderSettingsOutputGroupOutputOutputSettingsArchiveOutputSettingsContainerSettingsArgs.builder()
                                     .m2tsSettings(ChannelEncoderSettingsOutputGroupOutputOutputSettingsArchiveOutputSettingsContainerSettingsM2tsSettingsArgs.builder()
                                         .audioBufferModel("ATSC")
                                         .bufferModel("MULTIPLEX")
                                         .rateMode("CBR")
                                         .build())
                                     .build())
                                 .nameModifier("_1")
                                 .extension("m2ts")
                                 .build())
                             .build())
                         .outputName("example-name")
                         .videoDescriptionName("example-video")
                         .audioDescriptionNames("audio-selector")
                         .build())
                     .build())
                 .videoDescriptions(ChannelEncoderSettingsVideoDescriptionArgs.builder()
                     .name("example-video")
                     .build())
                 .build())
             .destinations(ChannelDestinationArgs.builder()
                 .settings(                
                     ChannelDestinationSettingArgs.builder()
                         .url(String.format("s3://%s/test1", main.id()))
                         .build(),
                     ChannelDestinationSettingArgs.builder()
                         .url(String.format("s3://%s/test2", main2.id()))
                         .build())
                 .id("destination")
                 .build())
             .inputAttachments(ChannelInputAttachmentArgs.builder()
                 .inputAttachmentName("example-input")
                 .inputId(exampleAwsMedialiveInput.id())
                 .build())
             .name("example-channel")
             .channelClass("STANDARD")
             .roleArn(exampleAwsIamRole.arn())
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `channelId` (String) ID of the MediaLive Channel. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import MediaLive Channel using the `channelId`. For example: ```sh $ pulumi import aws:medialive/channel:Channel example 1234567 ```

    • 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.util.Optional<ChannelCdiInputSpecification>> cdiInputSpecification()  
      com.pulumi.core.Output<java.lang.String> channelClass()  
      com.pulumi.core.Output<java.lang.String> channelId()  
      com.pulumi.core.Output<java.util.List<ChannelDestination>> destinations()  
      com.pulumi.core.Output<ChannelEncoderSettings> encoderSettings()  
      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.util.List<ChannelInputAttachment>> inputAttachments()  
      com.pulumi.core.Output<ChannelInputSpecification> inputSpecification()  
      com.pulumi.core.Output<java.lang.String> logLevel()  
      com.pulumi.core.Output<ChannelMaintenance> maintenance()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> roleArn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> startChannel()  
      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.util.Optional<ChannelVpc>> vpc()  

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

      • cdiInputSpecification

        public com.pulumi.core.Output<java.util.Optional<ChannelCdiInputSpecification>> cdiInputSpecification()
        Returns:
        Specification of CDI inputs for this channel. See `cdiInputSpecification` Block for details.

      • channelClass

        public com.pulumi.core.Output<java.lang.String> channelClass()
        Returns:
        Class of the channel. Valid values: `STANDARD`, `SINGLE_PIPELINE`.

      • channelId

        public com.pulumi.core.Output<java.lang.String> channelId()
        Returns:
        ID of the Channel.

      • destinations

        public com.pulumi.core.Output<java.util.List<ChannelDestination>> destinations()
        Returns:
        Destinations for the channel. See `destinations` Block for details.

      • encoderSettings

        public com.pulumi.core.Output<ChannelEncoderSettings> encoderSettings()
        Returns:
        Encoder settings. See `encoderSettings` Block for details.

      • inputAttachments

        public com.pulumi.core.Output<java.util.List<ChannelInputAttachment>> inputAttachments()
        Returns:
        Input attachments for the channel. See `inputAttachments` Block for details.

      • inputSpecification

        public com.pulumi.core.Output<ChannelInputSpecification> inputSpecification()
        Returns:
        Specification of network and file inputs for the channel. See `inputSpecification` Block for details.

      • logLevel

        public com.pulumi.core.Output<java.lang.String> logLevel()
        Returns:
        Level of verbosity for the logs written to CloudWatch Logs.

      • maintenance

        public com.pulumi.core.Output<ChannelMaintenance> maintenance()
        Returns:
        Maintenance settings for this channel. See `maintenance` Block for details.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the channel. The following arguments are optional:

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

      • roleArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> roleArn()
        Returns:
        ARN of the IAM role for the channel.

      • startChannel

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> startChannel()
        Returns:
        Whether to start/stop channel. Default: `false`.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the channel. 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. * `vpc[0].availability_zones` - Availability zones where the network interfaces are created. * `vpc[0].network_interface_ids` - Network interface IDs created in the output VPC.

      • vpc

        public com.pulumi.core.Output<java.util.Optional<ChannelVpc>> vpc()
        Returns:
        Settings for the VPC outputs. See `vpc` Block for details.

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