All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnOriginEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:40.440Z") @Stability(Stable) public interface CfnOriginEndpointProps extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnOriginEndpoint.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.mediapackage.*;
 CfnOriginEndpointProps cfnOriginEndpointProps = CfnOriginEndpointProps.builder()
         .channelId("channelId")
         .id("id")
         // the properties below are optional
         .authorization(AuthorizationProperty.builder()
                 .cdnIdentifierSecret("cdnIdentifierSecret")
                 .secretsRoleArn("secretsRoleArn")
                 .build())
         .cmafPackage(CmafPackageProperty.builder()
                 .encryption(CmafEncryptionProperty.builder()
                         .spekeKeyProvider(SpekeKeyProviderProperty.builder()
                                 .resourceId("resourceId")
                                 .roleArn("roleArn")
                                 .systemIds(List.of("systemIds"))
                                 .url("url")
                                 // the properties below are optional
                                 .certificateArn("certificateArn")
                                 .encryptionContractConfiguration(EncryptionContractConfigurationProperty.builder()
                                         .presetSpeke20Audio("presetSpeke20Audio")
                                         .presetSpeke20Video("presetSpeke20Video")
                                         .build())
                                 .build())
                         // the properties below are optional
                         .constantInitializationVector("constantInitializationVector")
                         .encryptionMethod("encryptionMethod")
                         .keyRotationIntervalSeconds(123)
                         .build())
                 .hlsManifests(List.of(HlsManifestProperty.builder()
                         .id("id")
                         // the properties below are optional
                         .adMarkers("adMarkers")
                         .adsOnDeliveryRestrictions("adsOnDeliveryRestrictions")
                         .adTriggers(List.of("adTriggers"))
                         .includeIframeOnlyStream(false)
                         .manifestName("manifestName")
                         .playlistType("playlistType")
                         .playlistWindowSeconds(123)
                         .programDateTimeIntervalSeconds(123)
                         .url("url")
                         .build()))
                 .segmentDurationSeconds(123)
                 .segmentPrefix("segmentPrefix")
                 .streamSelection(StreamSelectionProperty.builder()
                         .maxVideoBitsPerSecond(123)
                         .minVideoBitsPerSecond(123)
                         .streamOrder("streamOrder")
                         .build())
                 .build())
         .dashPackage(DashPackageProperty.builder()
                 .adsOnDeliveryRestrictions("adsOnDeliveryRestrictions")
                 .adTriggers(List.of("adTriggers"))
                 .encryption(DashEncryptionProperty.builder()
                         .spekeKeyProvider(SpekeKeyProviderProperty.builder()
                                 .resourceId("resourceId")
                                 .roleArn("roleArn")
                                 .systemIds(List.of("systemIds"))
                                 .url("url")
                                 // the properties below are optional
                                 .certificateArn("certificateArn")
                                 .encryptionContractConfiguration(EncryptionContractConfigurationProperty.builder()
                                         .presetSpeke20Audio("presetSpeke20Audio")
                                         .presetSpeke20Video("presetSpeke20Video")
                                         .build())
                                 .build())
                         // the properties below are optional
                         .keyRotationIntervalSeconds(123)
                         .build())
                 .includeIframeOnlyStream(false)
                 .manifestLayout("manifestLayout")
                 .manifestWindowSeconds(123)
                 .minBufferTimeSeconds(123)
                 .minUpdatePeriodSeconds(123)
                 .periodTriggers(List.of("periodTriggers"))
                 .profile("profile")
                 .segmentDurationSeconds(123)
                 .segmentTemplateFormat("segmentTemplateFormat")
                 .streamSelection(StreamSelectionProperty.builder()
                         .maxVideoBitsPerSecond(123)
                         .minVideoBitsPerSecond(123)
                         .streamOrder("streamOrder")
                         .build())
                 .suggestedPresentationDelaySeconds(123)
                 .utcTiming("utcTiming")
                 .utcTimingUri("utcTimingUri")
                 .build())
         .description("description")
         .hlsPackage(HlsPackageProperty.builder()
                 .adMarkers("adMarkers")
                 .adsOnDeliveryRestrictions("adsOnDeliveryRestrictions")
                 .adTriggers(List.of("adTriggers"))
                 .encryption(HlsEncryptionProperty.builder()
                         .spekeKeyProvider(SpekeKeyProviderProperty.builder()
                                 .resourceId("resourceId")
                                 .roleArn("roleArn")
                                 .systemIds(List.of("systemIds"))
                                 .url("url")
                                 // the properties below are optional
                                 .certificateArn("certificateArn")
                                 .encryptionContractConfiguration(EncryptionContractConfigurationProperty.builder()
                                         .presetSpeke20Audio("presetSpeke20Audio")
                                         .presetSpeke20Video("presetSpeke20Video")
                                         .build())
                                 .build())
                         // the properties below are optional
                         .constantInitializationVector("constantInitializationVector")
                         .encryptionMethod("encryptionMethod")
                         .keyRotationIntervalSeconds(123)
                         .repeatExtXKey(false)
                         .build())
                 .includeDvbSubtitles(false)
                 .includeIframeOnlyStream(false)
                 .playlistType("playlistType")
                 .playlistWindowSeconds(123)
                 .programDateTimeIntervalSeconds(123)
                 .segmentDurationSeconds(123)
                 .streamSelection(StreamSelectionProperty.builder()
                         .maxVideoBitsPerSecond(123)
                         .minVideoBitsPerSecond(123)
                         .streamOrder("streamOrder")
                         .build())
                 .useAudioRenditionGroup(false)
                 .build())
         .manifestName("manifestName")
         .mssPackage(MssPackageProperty.builder()
                 .encryption(MssEncryptionProperty.builder()
                         .spekeKeyProvider(SpekeKeyProviderProperty.builder()
                                 .resourceId("resourceId")
                                 .roleArn("roleArn")
                                 .systemIds(List.of("systemIds"))
                                 .url("url")
                                 // the properties below are optional
                                 .certificateArn("certificateArn")
                                 .encryptionContractConfiguration(EncryptionContractConfigurationProperty.builder()
                                         .presetSpeke20Audio("presetSpeke20Audio")
                                         .presetSpeke20Video("presetSpeke20Video")
                                         .build())
                                 .build())
                         .build())
                 .manifestWindowSeconds(123)
                 .segmentDurationSeconds(123)
                 .streamSelection(StreamSelectionProperty.builder()
                         .maxVideoBitsPerSecond(123)
                         .minVideoBitsPerSecond(123)
                         .streamOrder("streamOrder")
                         .build())
                 .build())
         .origination("origination")
         .startoverWindowSeconds(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .timeDelaySeconds(123)
         .whitelist(List.of("whitelist"))
         .build();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnOriginEndpointProps.Builder

A builder for CfnOriginEndpointProps

static final class

CfnOriginEndpointProps.Jsii$Proxy

An implementation for CfnOriginEndpointProps
Method Summary

Modifier and Type

Method

Description

static CfnOriginEndpointProps.Builder

builder()

default Object

getAuthorization()

Parameters for CDN authorization.

String

getChannelId()

The ID of the channel associated with this endpoint.

default Object

getCmafPackage()

Parameters for Common Media Application Format (CMAF) packaging.

default Object

getDashPackage()

Parameters for DASH packaging.

default String

getDescription()

Any descriptive information that you want to add to the endpoint for future identification purposes.

default Object

getHlsPackage()

Parameters for Apple HLS packaging.

String

getId()

The manifest ID is required and must be unique within the OriginEndpoint.

default String

getManifestName()

A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint.

default Object

getMssPackage()

Parameters for Microsoft Smooth Streaming packaging.

default String

getOrigination()

Controls video origination from this endpoint.

default Number

getStartoverWindowSeconds()

Maximum duration (seconds) of content to retain for startover playback.

default List<CfnTag>

getTags()

The tags to assign to the endpoint.

default Number

getTimeDelaySeconds()

Minimum duration (seconds) of delay to enforce on the playback of live content.

default List<String>

getWhitelist()

The IP addresses that can access this endpoint.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getChannelId
  
  @Stability(Stable) @NotNull String getChannelId()
  
  The ID of the channel associated with this endpoint.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-channelid
- getId
  
  @Stability(Stable) @NotNull String getId()
  
  The manifest ID is required and must be unique within the OriginEndpoint.
  The ID can't be changed after the endpoint is created.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-id
- getAuthorization
  
  @Stability(Stable) @Nullable default Object getAuthorization()
  
  Parameters for CDN authorization.
  Returns union: either IResolvable or CfnOriginEndpoint.AuthorizationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-authorization
- getCmafPackage
  
  @Stability(Stable) @Nullable default Object getCmafPackage()
  
  Parameters for Common Media Application Format (CMAF) packaging.
  Returns union: either IResolvable or CfnOriginEndpoint.CmafPackageProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-cmafpackage
- getDashPackage
  
  @Stability(Stable) @Nullable default Object getDashPackage()
  
  Parameters for DASH packaging.
  Returns union: either IResolvable or CfnOriginEndpoint.DashPackageProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-dashpackage
- getDescription
  
  @Stability(Stable) @Nullable default String getDescription()
  
  Any descriptive information that you want to add to the endpoint for future identification purposes.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-description
- getHlsPackage
  
  @Stability(Stable) @Nullable default Object getHlsPackage()
  
  Parameters for Apple HLS packaging.
  Returns union: either IResolvable or CfnOriginEndpoint.HlsPackageProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-hlspackage
- getManifestName
  
  @Stability(Stable) @Nullable default String getManifestName()
  
  A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-manifestname
- getMssPackage
  
  @Stability(Stable) @Nullable default Object getMssPackage()
  
  Parameters for Microsoft Smooth Streaming packaging.
  Returns union: either IResolvable or CfnOriginEndpoint.MssPackageProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-msspackage
- getOrigination
  
  @Stability(Stable) @Nullable default String getOrigination()
  Controls video origination from this endpoint.
  Valid values:
  
  ALLOW - enables this endpoint to serve content to requesting devices.
  
  DENY - prevents this endpoint from serving content. Denying origination is helpful for harvesting live-to-VOD assets. For more information about harvesting and origination, see Live-to-VOD Requirements .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-origination
- getStartoverWindowSeconds
  
  @Stability(Stable) @Nullable default Number getStartoverWindowSeconds()
  
  Maximum duration (seconds) of content to retain for startover playback.
  Omit this attribute or enter 0 to indicate that startover playback is disabled for this endpoint.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-startoverwindowseconds
- getTags
  
  @Stability(Stable) @Nullable default List<CfnTag> getTags()
  
  The tags to assign to the endpoint.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-tags
- getTimeDelaySeconds
  
  @Stability(Stable) @Nullable default Number getTimeDelaySeconds()
  
  Minimum duration (seconds) of delay to enforce on the playback of live content.
  Omit this attribute or enter 0 to indicate that there is no time delay in effect for this endpoint.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-timedelayseconds
- getWhitelist
  
  @Stability(Stable) @Nullable default List<String> getWhitelist()
  
  The IP addresses that can access this endpoint.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackage-originendpoint.html#cfn-mediapackage-originendpoint-whitelist
- builder
  
  @Stability(Stable) static CfnOriginEndpointProps.Builder builder()
  
  Returns:
  
  a CfnOriginEndpointProps.Builder of CfnOriginEndpointProps

Interface CfnOriginEndpointProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getChannelId

getId

getAuthorization

getCmafPackage

getDashPackage

getDescription

getHlsPackage

getManifestName

getMssPackage

getOrigination

getStartoverWindowSeconds

getTags

getTimeDelaySeconds

getWhitelist

builder