CfnOriginEndpoint

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.mediapackage.CfnOriginEndpoint

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:17.960Z")
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().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().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().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().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` Use `encryptionContractConfiguration` to configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0.
`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 interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnOriginEndpoint(Construct scope, java.lang.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

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

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.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
```
public CfnOriginEndpoint(Construct scope,
                         java.lang.String id,
                         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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
public java.lang.String getAttrArn()
```
    The endpoint's unique system-generated resource name, based on the AWS record.
  - getAttrUrl
```
public java.lang.String getAttrUrl()
```
    URL for the key provider’s key retrieval API endpoint.
    Must start with https://.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    The tags to assign to the endpoint.
  - getChannelId
```
public java.lang.String getChannelId()
```
    The ID of the channel associated with this endpoint.
  - setChannelId
```
public void setChannelId(java.lang.String value)
```
    The ID of the channel associated with this endpoint.
  - getId
```
public java.lang.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
```
public void setId(java.lang.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
```
public java.lang.Object getAuthorization()
```
    Parameters for CDN authorization.
  - setAuthorization
```
public void setAuthorization(IResolvable value)
```
    Parameters for CDN authorization.
  - setAuthorization
```
public void setAuthorization(CfnOriginEndpoint.AuthorizationProperty value)
```
    Parameters for CDN authorization.
  - getCmafPackage
```
public java.lang.Object getCmafPackage()
```
    Parameters for Common Media Application Format (CMAF) packaging.
  - setCmafPackage
```
public void setCmafPackage(IResolvable value)
```
    Parameters for Common Media Application Format (CMAF) packaging.
  - setCmafPackage
```
public void setCmafPackage(CfnOriginEndpoint.CmafPackageProperty value)
```
    Parameters for Common Media Application Format (CMAF) packaging.
  - getDashPackage
```
public java.lang.Object getDashPackage()
```
    Parameters for DASH packaging.
  - setDashPackage
```
public void setDashPackage(IResolvable value)
```
    Parameters for DASH packaging.
  - setDashPackage
```
public void setDashPackage(CfnOriginEndpoint.DashPackageProperty value)
```
    Parameters for DASH packaging.
  - getDescription
```
public java.lang.String getDescription()
```
    Any descriptive information that you want to add to the endpoint for future identification purposes.
  - setDescription
```
public void setDescription(java.lang.String value)
```
    Any descriptive information that you want to add to the endpoint for future identification purposes.
  - getHlsPackage
```
public java.lang.Object getHlsPackage()
```
    Parameters for Apple HLS packaging.
  - setHlsPackage
```
public void setHlsPackage(IResolvable value)
```
    Parameters for Apple HLS packaging.
  - setHlsPackage
```
public void setHlsPackage(CfnOriginEndpoint.HlsPackageProperty value)
```
    Parameters for Apple HLS packaging.
  - getManifestName
```
public java.lang.String getManifestName()
```
    A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint.
  - setManifestName
```
public void setManifestName(java.lang.String value)
```
    A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint.
  - getMssPackage
```
public java.lang.Object getMssPackage()
```
    Parameters for Microsoft Smooth Streaming packaging.
  - setMssPackage
```
public void setMssPackage(IResolvable value)
```
    Parameters for Microsoft Smooth Streaming packaging.
  - setMssPackage
```
public void setMssPackage(CfnOriginEndpoint.MssPackageProperty value)
```
    Parameters for Microsoft Smooth Streaming packaging.
  - getOrigination
```
public java.lang.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 .
  - setOrigination
```
public void setOrigination(java.lang.String value)
```
    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 .
  - getStartoverWindowSeconds
```
public java.lang.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
```
public void setStartoverWindowSeconds(java.lang.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
```
public java.lang.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
```
public void setTimeDelaySeconds(java.lang.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
```
public java.util.List<java.lang.String> getWhitelist()
```
    The IP addresses that can access this endpoint.
  - setWhitelist
```
public void setWhitelist(java.util.List<java.lang.String> value)
```
    The IP addresses that can access this endpoint.

Class CfnOriginEndpoint

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnOriginEndpoint

CfnOriginEndpoint

CfnOriginEndpoint

Method Detail

inspect

renderProperties

getAttrArn

getAttrUrl

getCfnProperties

getTags

getChannelId

setChannelId

getId

setId

getAuthorization

setAuthorization

setAuthorization

getCmafPackage

setCmafPackage

setCmafPackage

getDashPackage

setDashPackage

setDashPackage

getDescription

setDescription

getHlsPackage

setHlsPackage

setHlsPackage

getManifestName

setManifestName

getMssPackage

setMssPackage

setMssPackage

getOrigination

setOrigination

getStartoverWindowSeconds

setStartoverWindowSeconds

getTimeDelaySeconds

setTimeDelaySeconds

getWhitelist

setWhitelist