Class ChannelGroup.Builder
java.lang.Object
software.amazon.awscdk.services.mediapackagev2.alpha.ChannelGroup.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<ChannelGroup>
- Enclosing class:
ChannelGroup
@Stability(Experimental)
public static final class ChannelGroup.Builder
extends Object
implements software.amazon.jsii.Builder<ChannelGroup>
(experimental) A fluent builder for
ChannelGroup.-
Method Summary
Modifier and TypeMethodDescriptionbuild()channelGroupName(String channelGroupName) (experimental) The name that describes the channel group.static ChannelGroup.Builderdescription(String description) (experimental) The description for your channel group.removalPolicy(RemovalPolicy removalPolicy) (experimental) Policy to apply when the channel group is removed from the stack.(experimental) Tags to add to the Channel Group.
-
Method Details
-
create
@Stability(Experimental) public static ChannelGroup.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope- This parameter is required.id- This parameter is required.- Returns:
- a new instance of
ChannelGroup.Builder.
-
channelGroupName
(experimental) The name that describes the channel group.The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
Default: autogenerated
- Parameters:
channelGroupName- The name that describes the channel group. This parameter is required.- Returns:
this
-
description
(experimental) The description for your channel group.Default: - no description
- Parameters:
description- The description for your channel group. This parameter is required.- Returns:
this
-
removalPolicy
(experimental) Policy to apply when the channel group 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 toRETAINif 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 group is removed from the stack. This parameter is required.- Returns:
this
-
tags
(experimental) Tags to add to the Channel Group.Default: - No tagging
- Parameters:
tags- Tags to add to the Channel Group. This parameter is required.- Returns:
this
-
build
- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<ChannelGroup>- Returns:
- a newly built instance of
ChannelGroup.
-