Package software.amazon.awscdk.services.mediapackagev2

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:

IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-11T15:56:01.892Z")
@Stability(Stable)
public class CfnOriginEndpoint
extends CfnResource
implements IInspectable, 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
                 .drmSignaling("drmSignaling")
                 .filterConfiguration(FilterConfigurationProperty.builder()
                         .end("end")
                         .manifestFilter("manifestFilter")
                         .start("start")
                         .timeDelaySeconds(123)
                         .build())
                 .manifestWindowSeconds(123)
                 .minBufferTimeSeconds(123)
                 .minUpdatePeriodSeconds(123)
                 .periodTriggers(List.of("periodTriggers"))
                 .scteDash(ScteDashProperty.builder()
                         .adMarkerDash("adMarkerDash")
                         .build())
                 .segmentTemplateFormat("segmentTemplateFormat")
                 .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()
                         .end("end")
                         .manifestFilter("manifestFilter")
                         .start("start")
                         .timeDelaySeconds(123)
                         .build())
                 .manifestWindowSeconds(123)
                 .programDateTimeIntervalSeconds(123)
                 .scteHls(ScteHlsProperty.builder()
                         .adMarkerHls("adMarkerHls")
                         .build())
                 .url("url")
                 .build()))
         .lowLatencyHlsManifests(List.of(LowLatencyHlsManifestConfigurationProperty.builder()
                 .manifestName("manifestName")
                 // the properties below are optional
                 .childManifestName("childManifestName")
                 .filterConfiguration(FilterConfigurationProperty.builder()
                         .end("end")
                         .manifestFilter("manifestFilter")
                         .start("start")
                         .timeDelaySeconds(123)
                         .build())
                 .manifestWindowSeconds(123)
                 .programDateTimeIntervalSeconds(123)
                 .scteHls(ScteHlsProperty.builder()
                         .adMarkerHls("adMarkerHls")
                         .build())
                 .url("url")
                 .build()))
         .segment(SegmentProperty.builder()
                 .encryption(EncryptionProperty.builder()
                         .encryptionMethod(EncryptionMethodProperty.builder()
                                 .cmafEncryptionMethod("cmafEncryptionMethod")
                                 .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
                         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnOriginEndpoint.Builder	A fluent builder for CfnOriginEndpoint.
static interface	CfnOriginEndpoint.DashManifestConfigurationProperty	Retrieve the DASH manifest configuration.
static interface	CfnOriginEndpoint.DashUtcTimingProperty	Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).
static interface	CfnOriginEndpoint.EncryptionContractConfigurationProperty	Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0.
static interface	CfnOriginEndpoint.EncryptionMethodProperty	The encryption method associated with the origin endpoint.
static interface	CfnOriginEndpoint.EncryptionProperty	A collection of video encryption presets.
static interface	CfnOriginEndpoint.FilterConfigurationProperty	Filter 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 interface	CfnOriginEndpoint.ForceEndpointErrorConfigurationProperty	The failover settings for the endpoint.
static interface	CfnOriginEndpoint.HlsManifestConfigurationProperty	The HLS manfiest configuration associated with the origin endpoint.
static interface	CfnOriginEndpoint.LowLatencyHlsManifestConfigurationProperty	Specify a low-latency HTTP live streaming (LL-HLS) manifest configuration.
static interface	CfnOriginEndpoint.ScteDashProperty	The SCTE configuration.
static interface	CfnOriginEndpoint.ScteHlsProperty	The SCTE-35 HLS configuration associated with the origin endpoint.
static interface	CfnOriginEndpoint.ScteProperty	The SCTE-35 configuration associated with the origin endpoint.
static interface	CfnOriginEndpoint.SegmentProperty	The segment configuration, including the segment name, duration, and other configuration values.
static interface	CfnOriginEndpoint.SpekeKeyProviderProperty	The parameters for the SPEKE key provider.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnOriginEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnOriginEndpoint(software.amazon.jsii.JsiiObjectRef objRef)
	CfnOriginEndpoint(software.constructs.Construct scope, String id, CfnOriginEndpointProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	The Amazon Resource Name (ARN) of the origin endpoint.
String	getAttrCreatedAt()	The timestamp of the creation of the origin endpoint.
List<String>	getAttrDashManifestUrls()
List<String>	getAttrHlsManifestUrls()
List<String>	getAttrLowLatencyHlsManifestUrls()
String	getAttrModifiedAt()	The timestamp of the modification of the origin endpoint.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
String	getChannelGroupName()	The name of the channel group associated with the origin endpoint configuration.
String	getChannelName()	The channel name associated with the origin endpoint.
String	getContainerType()	The container type associated with the origin endpoint configuration.
Object	getDashManifests()	A DASH manifest configuration.
String	getDescription()	The description associated with the origin endpoint.
Object	getForceEndpointErrorConfiguration()	The failover settings for the endpoint.
Object	getHlsManifests()	The HLS manfiests associated with the origin endpoint configuration.
Object	getLowLatencyHlsManifests()	The low-latency HLS (LL-HLS) manifests associated with the origin endpoint.
String	getOriginEndpointName()	The name of the origin endpoint associated with the origin endpoint configuration.
Object	getSegment()	The segment associated with the origin endpoint.
Number	getStartoverWindowSeconds()	The size of the window (in seconds) to specify a window of the live stream that's available for on-demand viewing.
List<CfnTag>	getTags()	The tags associated with the origin endpoint.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setChannelGroupName(String value)	The name of the channel group associated with the origin endpoint configuration.
void	setChannelName(String value)	The channel name associated with the origin endpoint.
void	setContainerType(String value)	The container type associated with the origin endpoint configuration.
void	setDashManifests(List<Object> value)	A DASH manifest configuration.
void	setDashManifests(IResolvable value)	A DASH manifest configuration.
void	setDescription(String value)	The description associated with the origin endpoint.
void	setForceEndpointErrorConfiguration(IResolvable value)	The failover settings for the endpoint.
void	setForceEndpointErrorConfiguration(CfnOriginEndpoint.ForceEndpointErrorConfigurationProperty value)	The failover settings for the endpoint.
void	setHlsManifests(List<Object> value)	The HLS manfiests associated with the origin endpoint configuration.
void	setHlsManifests(IResolvable value)	The HLS manfiests associated with the origin endpoint configuration.
void	setLowLatencyHlsManifests(List<Object> value)	The low-latency HLS (LL-HLS) manifests associated with the origin endpoint.
void	setLowLatencyHlsManifests(IResolvable value)	The low-latency HLS (LL-HLS) manifests associated with the origin endpoint.
void	setOriginEndpointName(String value)	The name of the origin endpoint associated with the origin endpoint configuration.
void	setSegment(IResolvable value)	The segment associated with the origin endpoint.
void	setSegment(CfnOriginEndpoint.SegmentProperty value)	The segment associated with the origin endpoint.
void	setStartoverWindowSeconds(Number value)	The size of the window (in seconds) to specify a window of the live stream that's available for on-demand viewing.
void	setTags(List<CfnTag> value)	The 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, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String 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

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

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:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the origin endpoint.

getAttrCreatedAt

@Stability(Stable)
@NotNull
public String getAttrCreatedAt()

The timestamp of the creation of the origin endpoint.

getAttrDashManifestUrls

@Stability(Stable)
@NotNull
public List<String> getAttrDashManifestUrls()

getAttrHlsManifestUrls

@Stability(Stable)
@NotNull
public List<String> getAttrHlsManifestUrls()

getAttrLowLatencyHlsManifestUrls

@Stability(Stable)
@NotNull
public List<String> getAttrLowLatencyHlsManifestUrls()

getAttrModifiedAt

@Stability(Stable)
@NotNull
public String getAttrModifiedAt()

The timestamp of the modification of the origin endpoint.

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getChannelGroupName

@Stability(Stable)
@NotNull
public String getChannelGroupName()

The name of the channel group associated with the origin endpoint configuration.

setChannelGroupName

@Stability(Stable)
public void setChannelGroupName(@NotNull
 String value)

The name of the channel group associated with the origin endpoint configuration.

getChannelName

@Stability(Stable)
@NotNull
public String getChannelName()

The channel name associated with the origin endpoint.

setChannelName

@Stability(Stable)
public void setChannelName(@NotNull
 String value)

The channel name associated with the origin endpoint.

getContainerType

@Stability(Stable)
@NotNull
public String getContainerType()

The container type associated with the origin endpoint configuration.

setContainerType

@Stability(Stable)
public void setContainerType(@NotNull
 String value)

The container type associated with the origin endpoint configuration.

getOriginEndpointName

@Stability(Stable)
@NotNull
public String getOriginEndpointName()

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

setOriginEndpointName

@Stability(Stable)
public void setOriginEndpointName(@NotNull
 String value)

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

getDashManifests

@Stability(Stable)
@Nullable
public Object getDashManifests()

A DASH manifest configuration.

setDashManifests

@Stability(Stable)
public void setDashManifests(@Nullable
 IResolvable value)

A DASH manifest configuration.

setDashManifests

@Stability(Stable)
public void setDashManifests(@Nullable
 List<Object> value)

A DASH manifest configuration.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

The description associated with the origin endpoint.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The description associated with the origin endpoint.

getForceEndpointErrorConfiguration

@Stability(Stable)
@Nullable
public Object getForceEndpointErrorConfiguration()

The failover settings for the endpoint.

.

setForceEndpointErrorConfiguration

@Stability(Stable)
public void setForceEndpointErrorConfiguration(@Nullable
 IResolvable value)

The failover settings for the endpoint.

.

setForceEndpointErrorConfiguration

@Stability(Stable)
public void setForceEndpointErrorConfiguration(@Nullable
 CfnOriginEndpoint.ForceEndpointErrorConfigurationProperty value)

The failover settings for the endpoint.

.

getHlsManifests

@Stability(Stable)
@Nullable
public Object getHlsManifests()

The HLS manfiests associated with the origin endpoint configuration.

setHlsManifests

@Stability(Stable)
public void setHlsManifests(@Nullable
 IResolvable value)

The HLS manfiests associated with the origin endpoint configuration.

setHlsManifests

@Stability(Stable)
public void setHlsManifests(@Nullable
 List<Object> value)

The HLS manfiests associated with the origin endpoint configuration.

getLowLatencyHlsManifests

@Stability(Stable)
@Nullable
public Object getLowLatencyHlsManifests()

The low-latency HLS (LL-HLS) manifests associated with the origin endpoint.

setLowLatencyHlsManifests

@Stability(Stable)
public void setLowLatencyHlsManifests(@Nullable
 IResolvable value)

The low-latency HLS (LL-HLS) manifests associated with the origin endpoint.

setLowLatencyHlsManifests

@Stability(Stable)
public void setLowLatencyHlsManifests(@Nullable
 List<Object> value)

The low-latency HLS (LL-HLS) manifests associated with the origin endpoint.

getSegment

@Stability(Stable)
@Nullable
public Object getSegment()

The segment associated with the origin endpoint.

setSegment

@Stability(Stable)
public void setSegment(@Nullable
 IResolvable value)

The segment associated with the origin endpoint.

setSegment

@Stability(Stable)
public void setSegment(@Nullable
 CfnOriginEndpoint.SegmentProperty value)

The segment associated with the origin endpoint.

getStartoverWindowSeconds

@Stability(Stable)
@Nullable
public Number getStartoverWindowSeconds()

The size of the window (in seconds) to specify a window of the live stream that's available for on-demand viewing.

setStartoverWindowSeconds

@Stability(Stable)
public void setStartoverWindowSeconds(@Nullable
 Number value)

The size of the window (in seconds) to specify a window of the live stream that's available for on-demand viewing.

getTags

@Stability(Stable)
@Nullable
public List<CfnTag> getTags()

The tags associated with the origin endpoint.

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnTag> value)

The tags associated with the origin endpoint.