Package software.amazon.awscdk.services.mediapackagev2.alpha

Class Channel.Builder

java.lang.Object
software.amazon.awscdk.services.mediapackagev2.alpha.Channel.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<Channel>
Enclosing class:
Channel
@Stability(Experimental) public static final class Channel.Builder extends Object implements software.amazon.jsii.Builder<Channel>
(experimental) A fluent builder for Channel.

  • Method Details

    • create

      @Stability(Experimental) public static Channel.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of Channel.Builder.

    • channelName

      @Stability(Experimental) public Channel.Builder channelName(String channelName)
      (experimental) The name that describes the channel.

      The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

      Default: autogenerated

      Parameters:
      channelName - The name that describes the channel. This parameter is required.
      Returns:
      this

    • description

      @Stability(Experimental) public Channel.Builder description(String description)
      (experimental) Enter any descriptive text that helps you to identify the channel.

      Default: no description

      Parameters:
      description - Enter any descriptive text that helps you to identify the channel. This parameter is required.
      Returns:
      this

    • input

      @Stability(Experimental) public Channel.Builder input(InputConfiguration input)
      (experimental) Input configuration for the channel.

      Use InputConfiguration.hls() or InputConfiguration.cmaf() to create the configuration.

      Default: InputConfiguration.cmaf()

      Parameters:
      input - Input configuration for the channel. This parameter is required.
      Returns:
      this

    • removalPolicy

      @Stability(Experimental) public Channel.Builder removalPolicy(RemovalPolicy removalPolicy)
      (experimental) Policy to apply when the channel is removed from the stack.

      Even though MediaPackage ChannelGroups, Channels and OriginEndpoints are technically stateful, their contents are transient and it is common to add and remove these while rearchitecting your application. The default is therefore DESTROY. Change it to RETAIN if the content (in a lookback window) are so valuable that accidentally losing it would be unacceptable.

      Default: RemovalPolicy.DESTROY

      Parameters:
      removalPolicy - Policy to apply when the channel is removed from the stack. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Experimental) public Channel.Builder tags(Map<String,String> tags)
      (experimental) Tags to add to the Channel.

      Default: No tagging

      Parameters:
      tags - Tags to add to the Channel. This parameter is required.
      Returns:
      this

    • channelGroup

      @Stability(Experimental) public Channel.Builder channelGroup(IChannelGroup channelGroup)
      (experimental) Channel Group to add this Channel to.

      Parameters:
      channelGroup - Channel Group to add this Channel to. This parameter is required.
      Returns:
      this

    • build

      @Stability(Experimental) public Channel build()
      Specified by:
      build in interface software.amazon.jsii.Builder<Channel>
      Returns:
      a newly built instance of Channel.