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

Class OriginEndpointProps.Builder

java.lang.Object

software.amazon.awscdk.services.mediapackagev2.alpha.OriginEndpointProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<OriginEndpointProps>

Enclosing interface:

OriginEndpointProps

@Stability(Experimental)
public static final class OriginEndpointProps.Builder
extends Object
implements software.amazon.jsii.Builder<OriginEndpointProps>

A builder for OriginEndpointProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
OriginEndpointProps	build()	Builds the configured instance.
OriginEndpointProps.Builder	cdnAuth(CdnAuthConfiguration cdnAuth)	Sets the value of OriginEndpointOptions.getCdnAuth()
OriginEndpointProps.Builder	channel(IChannel channel)	Sets the value of OriginEndpointProps.getChannel()
OriginEndpointProps.Builder	description(String description)	Sets the value of OriginEndpointOptions.getDescription()
OriginEndpointProps.Builder	forceEndpointConfigurationConditions(List<? extends EndpointErrorConfiguration> forceEndpointConfigurationConditions)	Sets the value of OriginEndpointOptions.getForceEndpointConfigurationConditions()
OriginEndpointProps.Builder	manifests(List<? extends Manifest> manifests)	Sets the value of OriginEndpointOptions.getManifests()
OriginEndpointProps.Builder	originEndpointName(String originEndpointName)	Sets the value of OriginEndpointOptions.getOriginEndpointName()
OriginEndpointProps.Builder	removalPolicy(RemovalPolicy removalPolicy)	Sets the value of OriginEndpointOptions.getRemovalPolicy()
OriginEndpointProps.Builder	segment(SegmentConfiguration segment)	Sets the value of OriginEndpointOptions.getSegment()
OriginEndpointProps.Builder	startoverWindow(Duration startoverWindow)	Sets the value of OriginEndpointOptions.getStartoverWindow()
OriginEndpointProps.Builder	tags(Map<String,String> tags)	Sets the value of OriginEndpointOptions.getTags()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

channel

@Stability(Experimental)
public OriginEndpointProps.Builder channel(IChannel channel)

Sets the value of OriginEndpointProps.getChannel()

Parameters:

channel - The channel associated with the origin endpoint. This parameter is required.

Returns:

this

manifests

@Stability(Experimental)
public OriginEndpointProps.Builder manifests(List<? extends Manifest> manifests)

Sets the value of OriginEndpointOptions.getManifests()

Parameters:

manifests - Manifests configuration for HLS, Low Latency HLS and DASH. This parameter is required.

Returns:

this

segment

@Stability(Experimental)
public OriginEndpointProps.Builder segment(SegmentConfiguration segment)

Sets the value of OriginEndpointOptions.getSegment()

Parameters:

segment - The segment associated with the origin endpoint. This parameter is required. Inside the segment configuration you can define options such as encryption, SPEKE parameters and other general segment configurations.

Use Segment.ts() or Segment.cmaf() to create the configuration.

Returns:

this

cdnAuth

@Stability(Experimental)
public OriginEndpointProps.Builder cdnAuth(CdnAuthConfiguration cdnAuth)

Sets the value of OriginEndpointOptions.getCdnAuth()

Parameters:

cdnAuth - Provide access to MediaPackage V2 Origin Endpoint via secret header.

Returns:

this

description

@Stability(Experimental)
public OriginEndpointProps.Builder description(String description)

Sets the value of OriginEndpointOptions.getDescription()

Parameters:

description - The description associated with the origin endpoint.

Returns:

this

forceEndpointConfigurationConditions

@Stability(Experimental)
public OriginEndpointProps.Builder forceEndpointConfigurationConditions(List<? extends EndpointErrorConfiguration> forceEndpointConfigurationConditions)

Sets the value of OriginEndpointOptions.getForceEndpointConfigurationConditions()

Parameters:

forceEndpointConfigurationConditions - The failover settings for the endpoint.

Returns:

this

originEndpointName

@Stability(Experimental)
public OriginEndpointProps.Builder originEndpointName(String originEndpointName)

Sets the value of OriginEndpointOptions.getOriginEndpointName()

Parameters:

originEndpointName - The name of the origin endpoint associated with the origin endpoint configuration.

Returns:

this

removalPolicy

@Stability(Experimental)
public OriginEndpointProps.Builder removalPolicy(RemovalPolicy removalPolicy)

Sets the value of OriginEndpointOptions.getRemovalPolicy()

Parameters:

removalPolicy - Policy to apply when the origin endpoint 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.

Returns:

this

startoverWindow

@Stability(Experimental)
public OriginEndpointProps.Builder startoverWindow(Duration startoverWindow)

Sets the value of OriginEndpointOptions.getStartoverWindow()

Parameters:

startoverWindow - The size of the window to specify a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.

Returns:

this

tags

@Stability(Experimental)
public OriginEndpointProps.Builder tags(Map<String,String> tags)

Sets the value of OriginEndpointOptions.getTags()

Parameters:

tags - The tags associated with the origin endpoint.

Returns:

this

build

@Stability(Experimental)
public OriginEndpointProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<OriginEndpointProps>

Returns:

a new instance of OriginEndpointProps

Throws:

NullPointerException - if any required attribute was not provided