Class CfnOriginEndpoint
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.mediapackagev2.CfnOriginEndpoint
- All Implemented Interfaces:
IEnvironmentAware,IInspectable,ITaggableV2,IOriginEndpointRef,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
date="2025-11-10T13:40:09.930Z")
@Stability(Stable)
public class CfnOriginEndpoint
extends CfnResource
implements IInspectable, IOriginEndpointRef, ITaggableV2
Specifies the configuration parameters for a MediaPackage V2 origin endpoint.
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.mediapackagev2.*;
CfnOriginEndpoint cfnOriginEndpoint = CfnOriginEndpoint.Builder.create(this, "MyCfnOriginEndpoint")
.channelGroupName("channelGroupName")
.channelName("channelName")
.containerType("containerType")
.originEndpointName("originEndpointName")
// the properties below are optional
.dashManifests(List.of(DashManifestConfigurationProperty.builder()
.manifestName("manifestName")
// the properties below are optional
.baseUrls(List.of(DashBaseUrlProperty.builder()
.url("url")
// the properties below are optional
.dvbPriority(123)
.dvbWeight(123)
.serviceLocation("serviceLocation")
.build()))
.compactness("compactness")
.drmSignaling("drmSignaling")
.dvbSettings(DashDvbSettingsProperty.builder()
.errorMetrics(List.of(DashDvbMetricsReportingProperty.builder()
.reportingUrl("reportingUrl")
// the properties below are optional
.probability(123)
.build()))
.fontDownload(DashDvbFontDownloadProperty.builder()
.fontFamily("fontFamily")
.mimeType("mimeType")
.url("url")
.build())
.build())
.filterConfiguration(FilterConfigurationProperty.builder()
.clipStartTime("clipStartTime")
.end("end")
.manifestFilter("manifestFilter")
.start("start")
.timeDelaySeconds(123)
.build())
.manifestWindowSeconds(123)
.minBufferTimeSeconds(123)
.minUpdatePeriodSeconds(123)
.periodTriggers(List.of("periodTriggers"))
.profiles(List.of("profiles"))
.programInformation(DashProgramInformationProperty.builder()
.copyright("copyright")
.languageCode("languageCode")
.moreInformationUrl("moreInformationUrl")
.source("source")
.title("title")
.build())
.scteDash(ScteDashProperty.builder()
.adMarkerDash("adMarkerDash")
.build())
.segmentTemplateFormat("segmentTemplateFormat")
.subtitleConfiguration(DashSubtitleConfigurationProperty.builder()
.ttmlConfiguration(DashTtmlConfigurationProperty.builder()
.ttmlProfile("ttmlProfile")
.build())
.build())
.suggestedPresentationDelaySeconds(123)
.utcTiming(DashUtcTimingProperty.builder()
.timingMode("timingMode")
.timingSource("timingSource")
.build())
.build()))
.description("description")
.forceEndpointErrorConfiguration(ForceEndpointErrorConfigurationProperty.builder()
.endpointErrorConditions(List.of("endpointErrorConditions"))
.build())
.hlsManifests(List.of(HlsManifestConfigurationProperty.builder()
.manifestName("manifestName")
// the properties below are optional
.childManifestName("childManifestName")
.filterConfiguration(FilterConfigurationProperty.builder()
.clipStartTime("clipStartTime")
.end("end")
.manifestFilter("manifestFilter")
.start("start")
.timeDelaySeconds(123)
.build())
.manifestWindowSeconds(123)
.programDateTimeIntervalSeconds(123)
.scteHls(ScteHlsProperty.builder()
.adMarkerHls("adMarkerHls")
.build())
.startTag(StartTagProperty.builder()
.timeOffset(123)
// the properties below are optional
.precise(false)
.build())
.url("url")
.urlEncodeChildManifest(false)
.build()))
.lowLatencyHlsManifests(List.of(LowLatencyHlsManifestConfigurationProperty.builder()
.manifestName("manifestName")
// the properties below are optional
.childManifestName("childManifestName")
.filterConfiguration(FilterConfigurationProperty.builder()
.clipStartTime("clipStartTime")
.end("end")
.manifestFilter("manifestFilter")
.start("start")
.timeDelaySeconds(123)
.build())
.manifestWindowSeconds(123)
.programDateTimeIntervalSeconds(123)
.scteHls(ScteHlsProperty.builder()
.adMarkerHls("adMarkerHls")
.build())
.startTag(StartTagProperty.builder()
.timeOffset(123)
// the properties below are optional
.precise(false)
.build())
.url("url")
.urlEncodeChildManifest(false)
.build()))
.mssManifests(List.of(MssManifestConfigurationProperty.builder()
.manifestName("manifestName")
// the properties below are optional
.filterConfiguration(FilterConfigurationProperty.builder()
.clipStartTime("clipStartTime")
.end("end")
.manifestFilter("manifestFilter")
.start("start")
.timeDelaySeconds(123)
.build())
.manifestLayout("manifestLayout")
.manifestWindowSeconds(123)
.build()))
.segment(SegmentProperty.builder()
.encryption(EncryptionProperty.builder()
.encryptionMethod(EncryptionMethodProperty.builder()
.cmafEncryptionMethod("cmafEncryptionMethod")
.ismEncryptionMethod("ismEncryptionMethod")
.tsEncryptionMethod("tsEncryptionMethod")
.build())
.spekeKeyProvider(SpekeKeyProviderProperty.builder()
.drmSystems(List.of("drmSystems"))
.encryptionContractConfiguration(EncryptionContractConfigurationProperty.builder()
.presetSpeke20Audio("presetSpeke20Audio")
.presetSpeke20Video("presetSpeke20Video")
.build())
.resourceId("resourceId")
.roleArn("roleArn")
.url("url")
.build())
// the properties below are optional
.cmafExcludeSegmentDrmMetadata(false)
.constantInitializationVector("constantInitializationVector")
.keyRotationIntervalSeconds(123)
.build())
.includeIframeOnlyStreams(false)
.scte(ScteProperty.builder()
.scteFilter(List.of("scteFilter"))
.build())
.segmentDurationSeconds(123)
.segmentName("segmentName")
.tsIncludeDvbSubtitles(false)
.tsUseAudioRenditionGroup(false)
.build())
.startoverWindowSeconds(123)
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA fluent builder forCfnOriginEndpoint.static interfaceThe base URLs to use for retrieving segments.static interfaceFor use with DVB-DASH profiles only.static interfaceFor use with DVB-DASH profiles only.static interfaceFor endpoints that use the DVB-DASH profile only.static interfaceThe DASH manifest configuration associated with the origin endpoint.static interfaceDetails about the content that you want MediaPackage to pass through in the manifest to the playback device.static interfaceThe configuration for DASH subtitles.static interfaceThe settings for TTML subtitles.static interfaceDetermines the type of UTC timing included in the DASH Media Presentation Description (MPD).static interfaceUseencryptionContractConfigurationto configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0.static interfaceThe encryption method associated with the origin endpoint.static interfaceThe parameters for encrypting content.static interfaceFilter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.static interfaceThe failover settings for the endpoint.static interfaceThe HLS manifest configuration associated with the origin endpoint.static interfaceSpecify a low-latency HTTP live streaming (LL-HLS) manifest configuration.static interfaceConfiguration details for a Microsoft Smooth Streaming (MSS) manifest associated with an origin endpoint.static interfaceThe SCTE configuration.static interfaceThe SCTE-35 HLS configuration associated with the origin endpoint.static interfaceThe SCTE-35 configuration associated with the origin endpoint.static interfaceThe segment configuration, including the segment name, duration, and other configuration values.static interfaceThe parameters for the SPEKE key provider.static interfaceTo insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$DefaultNested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.services.mediapackagev2.IOriginEndpointRef
IOriginEndpointRef.Jsii$Default, IOriginEndpointRef.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2
ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCfnOriginEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnOriginEndpoint(software.amazon.jsii.JsiiObjectRef objRef) CfnOriginEndpoint(software.constructs.Construct scope, String id, CfnOriginEndpointProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the origin endpoint.The timestamp of the creation of the origin endpoint.The egress domain URL for stream delivery from MediaPackage.The egress domain URL for stream delivery from MediaPackage.The egress domain URL for stream delivery from MediaPackage.The timestamp of the modification of the origin endpoint.Tag Manager which manages the tags for this resource.The name of the channel group associated with the origin endpoint configuration.The channel name associated with the origin endpoint.The container type associated with the origin endpoint configuration.A DASH manifest configuration.The description associated with the origin endpoint.The failover settings for the endpoint.The HLS manifests associated with the origin endpoint configuration.The low-latency HLS (LL-HLS) manifests associated with the origin endpoint.A list of Microsoft Smooth Streaming (MSS) manifest configurations associated with the origin endpoint.The name of the origin endpoint associated with the origin endpoint configuration.A reference to a OriginEndpoint resource.The segment associated with the origin endpoint.The size of the window (in seconds) to specify a window of the live stream that's available for on-demand viewing.getTags()The tags associated with the origin endpoint.voidinspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties(Map<String, Object> props) voidsetChannelGroupName(String value) The name of the channel group associated with the origin endpoint configuration.voidsetChannelName(String value) The channel name associated with the origin endpoint.voidsetContainerType(String value) The container type associated with the origin endpoint configuration.voidsetDashManifests(List<Object> value) A DASH manifest configuration.voidsetDashManifests(IResolvable value) A DASH manifest configuration.voidsetDescription(String value) The description associated with the origin endpoint.voidThe failover settings for the endpoint.voidThe failover settings for the endpoint.voidsetHlsManifests(List<Object> value) The HLS manifests associated with the origin endpoint configuration.voidsetHlsManifests(IResolvable value) The HLS manifests associated with the origin endpoint configuration.voidsetLowLatencyHlsManifests(List<Object> value) The low-latency HLS (LL-HLS) manifests associated with the origin endpoint.voidThe low-latency HLS (LL-HLS) manifests associated with the origin endpoint.voidsetMssManifests(List<Object> value) A list of Microsoft Smooth Streaming (MSS) manifest configurations associated with the origin endpoint.voidsetMssManifests(IResolvable value) A list of Microsoft Smooth Streaming (MSS) manifest configurations associated with the origin endpoint.voidsetOriginEndpointName(String value) The name of the origin endpoint associated with the origin endpoint configuration.voidsetSegment(IResolvable value) The segment associated with the origin endpoint.voidThe segment associated with the origin endpoint.voidsetStartoverWindowSeconds(Number value) The size of the window (in seconds) to specify a window of the live stream that's available for on-demand viewing.voidThe tags associated with the origin endpoint.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validatePropertiesMethods inherited from class software.amazon.awscdk.CfnRefElement
getRefMethods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdMethods inherited from class software.constructs.Construct
getNode, isConstructMethods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface software.constructs.IConstruct
getNodeMethods inherited from interface software.amazon.awscdk.IEnvironmentAware
getEnvMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnOriginEndpoint
protected CfnOriginEndpoint(software.amazon.jsii.JsiiObjectRef objRef) -
CfnOriginEndpoint
protected CfnOriginEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnOriginEndpoint
@Stability(Stable) public CfnOriginEndpoint(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnOriginEndpointProps props) - Parameters:
scope- Scope in which this resource is defined. This parameter is required.id- Construct identifier for this resource (unique in its scope). This parameter is required.props- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspectin interfaceIInspectable- Parameters:
inspector- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderPropertiesin classCfnResource- Parameters:
props- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the origin endpoint. -
getAttrCreatedAt
The timestamp of the creation of the origin endpoint. -
getAttrDashManifestUrls
The egress domain URL for stream delivery from MediaPackage. -
getAttrHlsManifestUrls
The egress domain URL for stream delivery from MediaPackage. -
getAttrLowLatencyHlsManifestUrls
The egress domain URL for stream delivery from MediaPackage. -
getAttrModifiedAt
The timestamp of the modification of the origin endpoint. -
getAttrMssManifestUrls
-
getCdkTagManager
Tag Manager which manages the tags for this resource.- Specified by:
getCdkTagManagerin interfaceITaggableV2
-
getCfnProperties
- Overrides:
getCfnPropertiesin classCfnResource
-
getOriginEndpointRef
A reference to a OriginEndpoint resource.- Specified by:
getOriginEndpointRefin interfaceIOriginEndpointRef
-
getChannelGroupName
The name of the channel group associated with the origin endpoint configuration. -
setChannelGroupName
The name of the channel group associated with the origin endpoint configuration. -
getChannelName
The channel name associated with the origin endpoint. -
setChannelName
The channel name associated with the origin endpoint. -
getContainerType
The container type associated with the origin endpoint configuration. -
setContainerType
The container type associated with the origin endpoint configuration. -
getOriginEndpointName
The name of the origin endpoint associated with the origin endpoint configuration. -
setOriginEndpointName
The name of the origin endpoint associated with the origin endpoint configuration. -
getDashManifests
A DASH manifest configuration.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnOriginEndpoint.DashManifestConfigurationProperty> -
setDashManifests
A DASH manifest configuration. -
setDashManifests
A DASH manifest configuration. -
getDescription
The description associated with the origin endpoint. -
setDescription
The description associated with the origin endpoint. -
getForceEndpointErrorConfiguration
The failover settings for the endpoint.Returns union: either
IResolvableorCfnOriginEndpoint.ForceEndpointErrorConfigurationProperty -
setForceEndpointErrorConfiguration
The failover settings for the endpoint. -
setForceEndpointErrorConfiguration
@Stability(Stable) public void setForceEndpointErrorConfiguration(@Nullable CfnOriginEndpoint.ForceEndpointErrorConfigurationProperty value) The failover settings for the endpoint. -
getHlsManifests
The HLS manifests associated with the origin endpoint configuration.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnOriginEndpoint.HlsManifestConfigurationProperty> -
setHlsManifests
The HLS manifests associated with the origin endpoint configuration. -
setHlsManifests
The HLS manifests associated with the origin endpoint configuration. -
getLowLatencyHlsManifests
The low-latency HLS (LL-HLS) manifests associated with the origin endpoint.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnOriginEndpoint.LowLatencyHlsManifestConfigurationProperty> -
setLowLatencyHlsManifests
The low-latency HLS (LL-HLS) manifests associated with the origin endpoint. -
setLowLatencyHlsManifests
The low-latency HLS (LL-HLS) manifests associated with the origin endpoint. -
getMssManifests
A list of Microsoft Smooth Streaming (MSS) manifest configurations associated with the origin endpoint.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnOriginEndpoint.MssManifestConfigurationProperty> -
setMssManifests
A list of Microsoft Smooth Streaming (MSS) manifest configurations associated with the origin endpoint. -
setMssManifests
A list of Microsoft Smooth Streaming (MSS) manifest configurations associated with the origin endpoint. -
getSegment
The segment associated with the origin endpoint.Returns union: either
IResolvableorCfnOriginEndpoint.SegmentProperty -
setSegment
The segment associated with the origin endpoint. -
setSegment
The segment associated with the origin endpoint. -
getStartoverWindowSeconds
The size of the window (in seconds) to specify a window of the live stream that's available for on-demand viewing. -
setStartoverWindowSeconds
The size of the window (in seconds) to specify a window of the live stream that's available for on-demand viewing. -
getTags
The tags associated with the origin endpoint. -
setTags
The tags associated with the origin endpoint.
-