Class ChannelProps.Builder
java.lang.Object
software.amazon.awscdk.services.mediapackagev2.alpha.ChannelProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<ChannelProps>
- Enclosing interface:
ChannelProps
@Stability(Experimental)
public static final class ChannelProps.Builder
extends Object
implements software.amazon.jsii.Builder<ChannelProps>
A builder for
ChannelProps-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.channelGroup(IChannelGroup channelGroup) Sets the value ofChannelProps.getChannelGroup()channelName(String channelName) Sets the value ofChannelOptions.getChannelName()description(String description) Sets the value ofChannelOptions.getDescription()input(InputConfiguration input) Sets the value ofChannelOptions.getInput()removalPolicy(RemovalPolicy removalPolicy) Sets the value ofChannelOptions.getRemovalPolicy()Sets the value ofChannelOptions.getTags()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
channelGroup
Sets the value ofChannelProps.getChannelGroup()- Parameters:
channelGroup- Channel Group to add this Channel to. This parameter is required.- Returns:
this
-
channelName
Sets the value ofChannelOptions.getChannelName()- Parameters:
channelName- 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.- Returns:
this
-
description
Sets the value ofChannelOptions.getDescription()- Parameters:
description- Enter any descriptive text that helps you to identify the channel.- Returns:
this
-
input
Sets the value ofChannelOptions.getInput()- Parameters:
input- Input configuration for the channel. Use InputConfiguration.hls() or InputConfiguration.cmaf() to create the configuration.- Returns:
this
-
removalPolicy
Sets the value ofChannelOptions.getRemovalPolicy()- Parameters:
removalPolicy- 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 thereforeDESTROY. Change it toRETAINif the content (in a lookback window) are so valuable that accidentally losing it would be unacceptable.- Returns:
this
-
tags
Sets the value ofChannelOptions.getTags()- Parameters:
tags- Tags to add to the Channel.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<ChannelProps>- Returns:
- a new instance of
ChannelProps - Throws:
NullPointerException- if any required attribute was not provided
-