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

Class OriginEndpoint.Builder

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

  • Method Details

    • create

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

    • manifests

      @Stability(Experimental) public OriginEndpoint.Builder manifests(List<? extends Manifest> manifests)
      (experimental) Manifests configuration for HLS, Low Latency HLS and DASH.

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

    • segment

      @Stability(Experimental) public OriginEndpoint.Builder segment(SegmentConfiguration segment)
      (experimental) The segment associated with the origin endpoint.

      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.

      Parameters:
      segment - The segment associated with the origin endpoint. This parameter is required.
      Returns:
      this

    • cdnAuth

      @Stability(Experimental) public OriginEndpoint.Builder cdnAuth(CdnAuthConfiguration cdnAuth)
      (experimental) Provide access to MediaPackage V2 Origin Endpoint via secret header.

      Default: undefined - Not configured on endpoint

      Parameters:
      cdnAuth - Provide access to MediaPackage V2 Origin Endpoint via secret header. This parameter is required.
      Returns:
      this

    • description

      @Stability(Experimental) public OriginEndpoint.Builder description(String description)
      (experimental) The description associated with the origin endpoint.

      Default: undefined - No description is added to Origin Endpoint

      Parameters:
      description - The description associated with the origin endpoint. This parameter is required.
      Returns:
      this

    • forceEndpointConfigurationConditions

      @Stability(Experimental) public OriginEndpoint.Builder forceEndpointConfigurationConditions(List<? extends EndpointErrorConfiguration> forceEndpointConfigurationConditions)
      (experimental) The failover settings for the endpoint.

      Default: undefined - No force endpoint configuration is configured

      Parameters:
      forceEndpointConfigurationConditions - The failover settings for the endpoint. This parameter is required.
      Returns:
      this

    • originEndpointName

      @Stability(Experimental) public OriginEndpoint.Builder originEndpointName(String originEndpointName)
      (experimental) The name of the origin endpoint associated with the origin endpoint configuration.

      Default: autogenerated

      Parameters:
      originEndpointName - The name of the origin endpoint associated with the origin endpoint configuration. This parameter is required.
      Returns:
      this

    • removalPolicy

      @Stability(Experimental) public OriginEndpoint.Builder removalPolicy(RemovalPolicy removalPolicy)
      (experimental) 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.

      Default: RemovalPolicy.DESTROY

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

    • startoverWindow

      @Stability(Experimental) public OriginEndpoint.Builder startoverWindow(Duration startoverWindow)
      (experimental) 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.

      Default: 900

      Parameters:
      startoverWindow - The size of the window to specify a window of the live stream that's available for on-demand viewing. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Experimental) public OriginEndpoint.Builder tags(Map<String,String> tags)
      (experimental) The tags associated with the origin endpoint.

      Default: - No tagging

      Parameters:
      tags - The tags associated with the origin endpoint. This parameter is required.
      Returns:
      this

    • channel

      @Stability(Experimental) public OriginEndpoint.Builder channel(IChannel channel)
      (experimental) The channel associated with the origin endpoint.

      Parameters:
      channel - The channel associated with the origin endpoint. This parameter is required.
      Returns:
      this

    • build

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