software.amazon.awscdk.services.mediapackage

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.mediapackage.CfnOriginEndpoint

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.918Z")
 @Stability(value=Stable)
public class CfnOriginEndpoint
extends CfnResource
implements IInspectable

A CloudFormation `AWS::MediaPackage::OriginEndpoint`.

Create an endpoint on an AWS Elemental MediaPackage channel.

An endpoint represents a single delivery point of a channel, and defines content output handling through various components, such as packaging protocols, DRM and encryption integration, and more.

After it's created, an endpoint provides a fixed public URL. This URL remains the same throughout the lifetime of the endpoint, regardless of any failures or upgrades that might occur. Integrate the URL with a downstream CDN (such as Amazon CloudFront) or playback device.

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.*;
 CfnOriginEndpoint cfnOriginEndpoint = CfnOriginEndpoint.Builder.create(this, "MyCfnOriginEndpoint")
         .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")
                         .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())
                 .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnOriginEndpoint.AuthorizationProperty Parameters for enabling CDN authorization on the endpoint.
static class	CfnOriginEndpoint.Builder A fluent builder for CfnOriginEndpoint.
static interface	CfnOriginEndpoint.CmafEncryptionProperty Holds encryption information so that access to the content can be controlled by a DRM solution.
static interface	CfnOriginEndpoint.CmafPackageProperty Parameters for Common Media Application Format (CMAF) packaging.
static interface	CfnOriginEndpoint.DashEncryptionProperty Holds encryption information so that access to the content can be controlled by a DRM solution.
static interface	CfnOriginEndpoint.DashPackageProperty Parameters for DASH packaging.
static interface	CfnOriginEndpoint.EncryptionContractConfigurationProperty Example:
static interface	CfnOriginEndpoint.HlsEncryptionProperty Holds encryption information so that access to the content can be controlled by a DRM solution.
static interface	CfnOriginEndpoint.HlsManifestProperty An HTTP Live Streaming (HLS) manifest configuration on a CMAF endpoint.
static interface	CfnOriginEndpoint.HlsPackageProperty Parameters for Apple HLS packaging.
static interface	CfnOriginEndpoint.MssEncryptionProperty Holds encryption information so that access to the content can be controlled by a DRM solution.
static interface	CfnOriginEndpoint.MssPackageProperty Parameters for Microsoft Smooth Streaming packaging.
static interface	CfnOriginEndpoint.SpekeKeyProviderProperty Keyprovider settings for DRM.
static interface	CfnOriginEndpoint.StreamSelectionProperty Limitations for outputs from the endpoint, based on the video bitrate.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnOriginEndpoint(software.constructs.Construct scope, String id, CfnOriginEndpointProps props) Create a new `AWS::MediaPackage::OriginEndpoint`.
protected	CfnOriginEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnOriginEndpoint(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The endpoint's unique system-generated resource name, based on the AWS record.
String	getAttrUrl() URL for the key provider’s key retrieval API endpoint.
Object	getAuthorization() Parameters for CDN authorization.
protected Map<String,Object>	getCfnProperties()
String	getChannelId() The ID of the channel associated with this endpoint.
Object	getCmafPackage() Parameters for Common Media Application Format (CMAF) packaging.
Object	getDashPackage() Parameters for DASH packaging.
String	getDescription() Any descriptive information that you want to add to the endpoint for future identification purposes.
Object	getHlsPackage() Parameters for Apple HLS packaging.
String	getId() The manifest ID is required and must be unique within the OriginEndpoint.
String	getManifestName() A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint.
Object	getMssPackage() Parameters for Microsoft Smooth Streaming packaging.
String	getOrigination() Controls video origination from this endpoint.
Number	getStartoverWindowSeconds() Maximum duration (seconds) of content to retain for startover playback.
TagManager	getTags() The tags to assign to the endpoint.
Number	getTimeDelaySeconds() Minimum duration (seconds) of delay to enforce on the playback of live content.
List<String>	getWhitelist() The IP addresses that can access this endpoint.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAuthorization(CfnOriginEndpoint.AuthorizationProperty value) Parameters for CDN authorization.
void	setAuthorization(IResolvable value) Parameters for CDN authorization.
void	setChannelId(String value) The ID of the channel associated with this endpoint.
void	setCmafPackage(CfnOriginEndpoint.CmafPackageProperty value) Parameters for Common Media Application Format (CMAF) packaging.
void	setCmafPackage(IResolvable value) Parameters for Common Media Application Format (CMAF) packaging.
void	setDashPackage(CfnOriginEndpoint.DashPackageProperty value) Parameters for DASH packaging.
void	setDashPackage(IResolvable value) Parameters for DASH packaging.
void	setDescription(String value) Any descriptive information that you want to add to the endpoint for future identification purposes.
void	setHlsPackage(CfnOriginEndpoint.HlsPackageProperty value) Parameters for Apple HLS packaging.
void	setHlsPackage(IResolvable value) Parameters for Apple HLS packaging.
void	setId(String value) The manifest ID is required and must be unique within the OriginEndpoint.
void	setManifestName(String value) A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint.
void	setMssPackage(CfnOriginEndpoint.MssPackageProperty value) Parameters for Microsoft Smooth Streaming packaging.
void	setMssPackage(IResolvable value) Parameters for Microsoft Smooth Streaming packaging.
void	setOrigination(String value) Controls video origination from this endpoint.
void	setStartoverWindowSeconds(Number value) Maximum duration (seconds) of content to retain for startover playback.
void	setTimeDelaySeconds(Number value) Minimum duration (seconds) of delay to enforce on the playback of live content.
void	setWhitelist(List<String> value) The IP addresses that can access this endpoint.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnOriginEndpoint

protected CfnOriginEndpoint(software.amazon.jsii.JsiiObjectRef objRef)

CfnOriginEndpoint

protected CfnOriginEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnOriginEndpoint

@Stability(value=Stable)
public CfnOriginEndpoint(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  CfnOriginEndpointProps props)

Create a new `AWS::MediaPackage::OriginEndpoint`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrArn()

The endpoint's unique system-generated resource name, based on the AWS record.

getAttrUrl

@Stability(value=Stable)
 @NotNull
public String getAttrUrl()

URL for the key provider’s key retrieval API endpoint.

Must start with https://.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags to assign to the endpoint.

getChannelId

@Stability(value=Stable)
 @NotNull
public String getChannelId()

The ID of the channel associated with this endpoint.

setChannelId

@Stability(value=Stable)
public void setChannelId(@NotNull
                                                  String value)

The ID of the channel associated with this endpoint.

getId

@Stability(value=Stable)
 @NotNull
public 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.

setId

@Stability(value=Stable)
public void setId(@NotNull
                                           String value)

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

The ID can't be changed after the endpoint is created.

getAuthorization

@Stability(value=Stable)
 @Nullable
public Object getAuthorization()

Parameters for CDN authorization.

setAuthorization

@Stability(value=Stable)
public void setAuthorization(@Nullable
                                                      CfnOriginEndpoint.AuthorizationProperty value)

Parameters for CDN authorization.

setAuthorization

@Stability(value=Stable)
public void setAuthorization(@Nullable
                                                      IResolvable value)

Parameters for CDN authorization.

getCmafPackage

@Stability(value=Stable)
 @Nullable
public Object getCmafPackage()

Parameters for Common Media Application Format (CMAF) packaging.

setCmafPackage

@Stability(value=Stable)
public void setCmafPackage(@Nullable
                                                    CfnOriginEndpoint.CmafPackageProperty value)

Parameters for Common Media Application Format (CMAF) packaging.

setCmafPackage

@Stability(value=Stable)
public void setCmafPackage(@Nullable
                                                    IResolvable value)

Parameters for Common Media Application Format (CMAF) packaging.

getDashPackage

@Stability(value=Stable)
 @Nullable
public Object getDashPackage()

Parameters for DASH packaging.

setDashPackage

@Stability(value=Stable)
public void setDashPackage(@Nullable
                                                    CfnOriginEndpoint.DashPackageProperty value)

Parameters for DASH packaging.

setDashPackage

@Stability(value=Stable)
public void setDashPackage(@Nullable
                                                    IResolvable value)

Parameters for DASH packaging.

getDescription

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

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

setDescription

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

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

getHlsPackage

@Stability(value=Stable)
 @Nullable
public Object getHlsPackage()

Parameters for Apple HLS packaging.

setHlsPackage

@Stability(value=Stable)
public void setHlsPackage(@Nullable
                                                   CfnOriginEndpoint.HlsPackageProperty value)

Parameters for Apple HLS packaging.

setHlsPackage

@Stability(value=Stable)
public void setHlsPackage(@Nullable
                                                   IResolvable value)

Parameters for Apple HLS packaging.

getManifestName

@Stability(value=Stable)
 @Nullable
public String getManifestName()

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

setManifestName

@Stability(value=Stable)
public void setManifestName(@Nullable
                                                     String value)

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

getMssPackage

@Stability(value=Stable)
 @Nullable
public Object getMssPackage()

Parameters for Microsoft Smooth Streaming packaging.

setMssPackage

@Stability(value=Stable)
public void setMssPackage(@Nullable
                                                   CfnOriginEndpoint.MssPackageProperty value)

Parameters for Microsoft Smooth Streaming packaging.

setMssPackage

@Stability(value=Stable)
public void setMssPackage(@Nullable
                                                   IResolvable value)

Parameters for Microsoft Smooth Streaming packaging.

getOrigination

@Stability(value=Stable)
 @Nullable
public String getOrigination()

Controls video origination from this endpoint.

• 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 .

setOrigination

@Stability(value=Stable)
public void setOrigination(@Nullable
                                                    String value)

Controls video origination from this endpoint.

• 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 .

getStartoverWindowSeconds

@Stability(value=Stable)
 @Nullable
public 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.

setStartoverWindowSeconds

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

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.

getTimeDelaySeconds

@Stability(value=Stable)
 @Nullable
public 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

setTimeDelaySeconds

@Stability(value=Stable)
public void setTimeDelaySeconds(@Nullable
                                                         Number value)

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

getWhitelist

@Stability(value=Stable)
 @Nullable
public List<String> getWhitelist()

The IP addresses that can access this endpoint.

setWhitelist

@Stability(value=Stable)
public void setWhitelist(@Nullable
                                                  List<String> value)

The IP addresses that can access this endpoint.