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
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-12-11T23:26:36.351Z")
@Stability(Stable)
public class CfnOriginEndpoint
extends CfnResource
implements IInspectable, ITaggable
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") .encryptionMethod("encryptionMethod") .keyRotationIntervalSeconds(123) .build()) .hlsManifests(List.of(HlsManifestProperty.builder() .id("id") // the properties below are optional .adMarkers("adMarkers") .adsOnDeliveryRestrictions("adsOnDeliveryRestrictions") .adTriggers(List.of("adTriggers")) .includeIframeOnlyStream(false) .manifestName("manifestName") .playlistType("playlistType") .playlistWindowSeconds(123) .programDateTimeIntervalSeconds(123) .url("url") .build())) .segmentDurationSeconds(123) .segmentPrefix("segmentPrefix") .streamSelection(StreamSelectionProperty.builder() .maxVideoBitsPerSecond(123) .minVideoBitsPerSecond(123) .streamOrder("streamOrder") .build()) .build()) .dashPackage(DashPackageProperty.builder() .adsOnDeliveryRestrictions("adsOnDeliveryRestrictions") .adTriggers(List.of("adTriggers")) .encryption(DashEncryptionProperty.builder() .spekeKeyProvider(SpekeKeyProviderProperty.builder() .resourceId("resourceId") .roleArn("roleArn") .systemIds(List.of("systemIds")) .url("url") // the properties below are optional .certificateArn("certificateArn") .encryptionContractConfiguration(EncryptionContractConfigurationProperty.builder() .presetSpeke20Audio("presetSpeke20Audio") .presetSpeke20Video("presetSpeke20Video") .build()) .build()) // the properties below are optional .keyRotationIntervalSeconds(123) .build()) .includeIframeOnlyStream(false) .manifestLayout("manifestLayout") .manifestWindowSeconds(123) .minBufferTimeSeconds(123) .minUpdatePeriodSeconds(123) .periodTriggers(List.of("periodTriggers")) .profile("profile") .segmentDurationSeconds(123) .segmentTemplateFormat("segmentTemplateFormat") .streamSelection(StreamSelectionProperty.builder() .maxVideoBitsPerSecond(123) .minVideoBitsPerSecond(123) .streamOrder("streamOrder") .build()) .suggestedPresentationDelaySeconds(123) .utcTiming("utcTiming") .utcTimingUri("utcTimingUri") .build()) .description("description") .hlsPackage(HlsPackageProperty.builder() .adMarkers("adMarkers") .adsOnDeliveryRestrictions("adsOnDeliveryRestrictions") .adTriggers(List.of("adTriggers")) .encryption(HlsEncryptionProperty.builder() .spekeKeyProvider(SpekeKeyProviderProperty.builder() .resourceId("resourceId") .roleArn("roleArn") .systemIds(List.of("systemIds")) .url("url") // the properties below are optional .certificateArn("certificateArn") .encryptionContractConfiguration(EncryptionContractConfigurationProperty.builder() .presetSpeke20Audio("presetSpeke20Audio") .presetSpeke20Video("presetSpeke20Video") .build()) .build()) // the properties below are optional .constantInitializationVector("constantInitializationVector") .encryptionMethod("encryptionMethod") .keyRotationIntervalSeconds(123) .repeatExtXKey(false) .build()) .includeDvbSubtitles(false) .includeIframeOnlyStream(false) .playlistType("playlistType") .playlistWindowSeconds(123) .programDateTimeIntervalSeconds(123) .segmentDurationSeconds(123) .streamSelection(StreamSelectionProperty.builder() .maxVideoBitsPerSecond(123) .minVideoBitsPerSecond(123) .streamOrder("streamOrder") .build()) .useAudioRenditionGroup(false) .build()) .manifestName("manifestName") .mssPackage(MssPackageProperty.builder() .encryption(MssEncryptionProperty.builder() .spekeKeyProvider(SpekeKeyProviderProperty.builder() .resourceId("resourceId") .roleArn("roleArn") .systemIds(List.of("systemIds")) .url("url") // the properties below are optional .certificateArn("certificateArn") .encryptionContractConfiguration(EncryptionContractConfigurationProperty.builder() .presetSpeke20Audio("presetSpeke20Audio") .presetSpeke20Video("presetSpeke20Video") .build()) .build()) .build()) .manifestWindowSeconds(123) .segmentDurationSeconds(123) .streamSelection(StreamSelectionProperty.builder() .maxVideoBitsPerSecond(123) .minVideoBitsPerSecond(123) .streamOrder("streamOrder") .build()) .build()) .origination("origination") .startoverWindowSeconds(123) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .timeDelaySeconds(123) .whitelist(List.of("whitelist")) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Parameters for enabling CDN authorization on the endpoint.static final class
A fluent builder forCfnOriginEndpoint
.static interface
Holds encryption information so that access to the content can be controlled by a DRM solution.static interface
Parameters for Common Media Application Format (CMAF) packaging.static interface
Holds encryption information so that access to the content can be controlled by a DRM solution.static interface
Parameters for DASH packaging.static interface
UseencryptionContractConfiguration
to configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0.static interface
Holds encryption information so that access to the content can be controlled by a DRM solution.static interface
An HTTP Live Streaming (HLS) manifest configuration on a CMAF endpoint.static interface
Parameters for Apple HLS packaging.static interface
Holds encryption information so that access to the content can be controlled by a DRM solution.static interface
Parameters for Microsoft Smooth Streaming packaging.static interface
Key provider settings for DRM.static interface
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.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.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
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 TypeMethodDescriptionThe endpoint's unique system-generated resource name, based on the AWS record.URL for the key provider’s key retrieval API endpoint.Parameters for CDN authorization.The ID of the channel associated with this endpoint.Parameters for Common Media Application Format (CMAF) packaging.Parameters for DASH packaging.Any descriptive information that you want to add to the endpoint for future identification purposes.Parameters for Apple HLS packaging.getId()
The manifest ID is required and must be unique within the OriginEndpoint.A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint.Parameters for Microsoft Smooth Streaming packaging.Controls video origination from this endpoint.Maximum duration (seconds) of content to retain for startover playback.getTags()
Tag Manager which manages the tags for this resource.The tags to assign to the endpoint.Minimum duration (seconds) of delay to enforce on the playback of live content.The IP addresses that can access this endpoint.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setAuthorization
(IResolvable value) Parameters for CDN authorization.void
Parameters for CDN authorization.void
setChannelId
(String value) The ID of the channel associated with this endpoint.void
setCmafPackage
(IResolvable value) Parameters for Common Media Application Format (CMAF) packaging.void
Parameters for Common Media Application Format (CMAF) packaging.void
setDashPackage
(IResolvable value) Parameters for DASH packaging.void
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
(IResolvable value) Parameters for Apple HLS packaging.void
Parameters for Apple HLS packaging.void
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
(IResolvable value) Parameters for Microsoft Smooth Streaming packaging.void
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
setTagsRaw
(List<CfnTag> value) The tags to assign to the endpoint.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, 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
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:
inspect
in 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:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The endpoint's unique system-generated resource name, based on the AWS record. -
getAttrUrl
URL for the key provider’s key retrieval API endpoint.Must start with https://.
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getChannelId
The ID of the channel associated with this endpoint. -
setChannelId
The ID of the channel associated with this endpoint. -
getId
The manifest ID is required and must be unique within the OriginEndpoint. -
setId
The manifest ID is required and must be unique within the OriginEndpoint. -
getAuthorization
Parameters for CDN authorization. -
setAuthorization
Parameters for CDN authorization. -
setAuthorization
@Stability(Stable) public void setAuthorization(@Nullable CfnOriginEndpoint.AuthorizationProperty value) Parameters for CDN authorization. -
getCmafPackage
Parameters for Common Media Application Format (CMAF) packaging. -
setCmafPackage
Parameters for Common Media Application Format (CMAF) packaging. -
setCmafPackage
@Stability(Stable) public void setCmafPackage(@Nullable CfnOriginEndpoint.CmafPackageProperty value) Parameters for Common Media Application Format (CMAF) packaging. -
getDashPackage
Parameters for DASH packaging. -
setDashPackage
Parameters for DASH packaging. -
setDashPackage
@Stability(Stable) public void setDashPackage(@Nullable CfnOriginEndpoint.DashPackageProperty value) Parameters for DASH packaging. -
getDescription
Any descriptive information that you want to add to the endpoint for future identification purposes. -
setDescription
Any descriptive information that you want to add to the endpoint for future identification purposes. -
getHlsPackage
Parameters for Apple HLS packaging. -
setHlsPackage
Parameters for Apple HLS packaging. -
setHlsPackage
Parameters for Apple HLS packaging. -
getManifestName
A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint. -
setManifestName
A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint. -
getMssPackage
Parameters for Microsoft Smooth Streaming packaging. -
setMssPackage
Parameters for Microsoft Smooth Streaming packaging. -
setMssPackage
Parameters for Microsoft Smooth Streaming packaging. -
getOrigination
Controls video origination from this endpoint. -
setOrigination
Controls video origination from this endpoint. -
getStartoverWindowSeconds
Maximum duration (seconds) of content to retain for startover playback. -
setStartoverWindowSeconds
Maximum duration (seconds) of content to retain for startover playback. -
getTagsRaw
The tags to assign to the endpoint. -
setTagsRaw
The tags to assign to the endpoint. -
getTimeDelaySeconds
Minimum duration (seconds) of delay to enforce on the playback of live content. -
setTimeDelaySeconds
Minimum duration (seconds) of delay to enforce on the playback of live content. -
getWhitelist
The IP addresses that can access this endpoint. -
setWhitelist
The IP addresses that can access this endpoint.
-