Class CfnOriginEndpoint
A CloudFormation AWS::MediaPackage::OriginEndpoint
.
Inherited Members
Namespace: Amazon.CDK.AWS.MediaPackage
Assembly: Amazon.CDK.AWS.MediaPackage.dll
Syntax (csharp)
public class CfnOriginEndpoint : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnOriginEndpoint
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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.
CloudformationResource: AWS::MediaPackage::OriginEndpoint
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.MediaPackage;
var cfnOriginEndpoint = new CfnOriginEndpoint(this, "MyCfnOriginEndpoint", new CfnOriginEndpointProps {
ChannelId = "channelId",
Id = "id",
// the properties below are optional
Authorization = new AuthorizationProperty {
CdnIdentifierSecret = "cdnIdentifierSecret",
SecretsRoleArn = "secretsRoleArn"
},
CmafPackage = new CmafPackageProperty {
Encryption = new CmafEncryptionProperty {
SpekeKeyProvider = new SpekeKeyProviderProperty {
ResourceId = "resourceId",
RoleArn = "roleArn",
SystemIds = new [] { "systemIds" },
Url = "url",
// the properties below are optional
CertificateArn = "certificateArn",
EncryptionContractConfiguration = new EncryptionContractConfigurationProperty { }
},
// the properties below are optional
ConstantInitializationVector = "constantInitializationVector",
EncryptionMethod = "encryptionMethod",
KeyRotationIntervalSeconds = 123
},
HlsManifests = new [] { new HlsManifestProperty {
Id = "id",
// the properties below are optional
AdMarkers = "adMarkers",
AdsOnDeliveryRestrictions = "adsOnDeliveryRestrictions",
AdTriggers = new [] { "adTriggers" },
IncludeIframeOnlyStream = false,
ManifestName = "manifestName",
PlaylistType = "playlistType",
PlaylistWindowSeconds = 123,
ProgramDateTimeIntervalSeconds = 123,
Url = "url"
} },
SegmentDurationSeconds = 123,
SegmentPrefix = "segmentPrefix",
StreamSelection = new StreamSelectionProperty {
MaxVideoBitsPerSecond = 123,
MinVideoBitsPerSecond = 123,
StreamOrder = "streamOrder"
}
},
DashPackage = new DashPackageProperty {
AdsOnDeliveryRestrictions = "adsOnDeliveryRestrictions",
AdTriggers = new [] { "adTriggers" },
Encryption = new DashEncryptionProperty {
SpekeKeyProvider = new SpekeKeyProviderProperty {
ResourceId = "resourceId",
RoleArn = "roleArn",
SystemIds = new [] { "systemIds" },
Url = "url",
// the properties below are optional
CertificateArn = "certificateArn",
EncryptionContractConfiguration = new EncryptionContractConfigurationProperty { }
},
// the properties below are optional
KeyRotationIntervalSeconds = 123
},
IncludeIframeOnlyStream = false,
ManifestLayout = "manifestLayout",
ManifestWindowSeconds = 123,
MinBufferTimeSeconds = 123,
MinUpdatePeriodSeconds = 123,
PeriodTriggers = new [] { "periodTriggers" },
Profile = "profile",
SegmentDurationSeconds = 123,
SegmentTemplateFormat = "segmentTemplateFormat",
StreamSelection = new StreamSelectionProperty {
MaxVideoBitsPerSecond = 123,
MinVideoBitsPerSecond = 123,
StreamOrder = "streamOrder"
},
SuggestedPresentationDelaySeconds = 123,
UtcTiming = "utcTiming",
UtcTimingUri = "utcTimingUri"
},
Description = "description",
HlsPackage = new HlsPackageProperty {
AdMarkers = "adMarkers",
AdsOnDeliveryRestrictions = "adsOnDeliveryRestrictions",
AdTriggers = new [] { "adTriggers" },
Encryption = new HlsEncryptionProperty {
SpekeKeyProvider = new SpekeKeyProviderProperty {
ResourceId = "resourceId",
RoleArn = "roleArn",
SystemIds = new [] { "systemIds" },
Url = "url",
// the properties below are optional
CertificateArn = "certificateArn",
EncryptionContractConfiguration = new EncryptionContractConfigurationProperty { }
},
// the properties below are optional
ConstantInitializationVector = "constantInitializationVector",
EncryptionMethod = "encryptionMethod",
KeyRotationIntervalSeconds = 123,
RepeatExtXKey = false
},
IncludeDvbSubtitles = false,
IncludeIframeOnlyStream = false,
PlaylistType = "playlistType",
PlaylistWindowSeconds = 123,
ProgramDateTimeIntervalSeconds = 123,
SegmentDurationSeconds = 123,
StreamSelection = new StreamSelectionProperty {
MaxVideoBitsPerSecond = 123,
MinVideoBitsPerSecond = 123,
StreamOrder = "streamOrder"
},
UseAudioRenditionGroup = false
},
ManifestName = "manifestName",
MssPackage = new MssPackageProperty {
Encryption = new MssEncryptionProperty {
SpekeKeyProvider = new SpekeKeyProviderProperty {
ResourceId = "resourceId",
RoleArn = "roleArn",
SystemIds = new [] { "systemIds" },
Url = "url",
// the properties below are optional
CertificateArn = "certificateArn",
EncryptionContractConfiguration = new EncryptionContractConfigurationProperty { }
}
},
ManifestWindowSeconds = 123,
SegmentDurationSeconds = 123,
StreamSelection = new StreamSelectionProperty {
MaxVideoBitsPerSecond = 123,
MinVideoBitsPerSecond = 123,
StreamOrder = "streamOrder"
}
},
Origination = "origination",
StartoverWindowSeconds = 123,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TimeDelaySeconds = 123,
Whitelist = new [] { "whitelist" }
});
Synopsis
Constructors
CfnOriginEndpoint(Construct, String, ICfnOriginEndpointProps) | Create a new |
CfnOriginEndpoint(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnOriginEndpoint(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The endpoint's unique system-generated resource name, based on the AWS record. |
AttrUrl | URL for the key provider’s key retrieval API endpoint. |
Authorization | Parameters for CDN authorization. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ChannelId | The ID of the channel associated with this endpoint. |
CmafPackage | Parameters for Common Media Application Format (CMAF) packaging. |
DashPackage | Parameters for DASH packaging. |
Description | Any descriptive information that you want to add to the endpoint for future identification purposes. |
HlsPackage | Parameters for Apple HLS packaging. |
Id | The manifest ID is required and must be unique within the OriginEndpoint. |
ManifestName | A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint. |
MssPackage | Parameters for Microsoft Smooth Streaming packaging. |
Origination | Controls video origination from this endpoint. |
StartoverWindowSeconds | Maximum duration (seconds) of content to retain for startover playback. |
Tags | The tags to assign to the endpoint. |
TimeDelaySeconds | Minimum duration (seconds) of delay to enforce on the playback of live content. |
Whitelist | The IP addresses that can access this endpoint. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnOriginEndpoint(Construct, String, ICfnOriginEndpointProps)
Create a new AWS::MediaPackage::OriginEndpoint
.
public CfnOriginEndpoint(Construct scope, string id, ICfnOriginEndpointProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnOriginEndpointProps
- resource properties.
CfnOriginEndpoint(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnOriginEndpoint(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnOriginEndpoint(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnOriginEndpoint(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The endpoint's unique system-generated resource name, based on the AWS record.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrUrl
URL for the key provider’s key retrieval API endpoint.
public virtual string AttrUrl { get; }
Property Value
System.String
Remarks
Must start with https://.
CloudformationAttribute: Url
Authorization
Parameters for CDN authorization.
public virtual object Authorization { get; set; }
Property Value
System.Object
Remarks
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ChannelId
The ID of the channel associated with this endpoint.
public virtual string ChannelId { get; set; }
Property Value
System.String
Remarks
CmafPackage
Parameters for Common Media Application Format (CMAF) packaging.
public virtual object CmafPackage { get; set; }
Property Value
System.Object
Remarks
DashPackage
Parameters for DASH packaging.
public virtual object DashPackage { get; set; }
Property Value
System.Object
Remarks
Description
Any descriptive information that you want to add to the endpoint for future identification purposes.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
HlsPackage
Parameters for Apple HLS packaging.
public virtual object HlsPackage { get; set; }
Property Value
System.Object
Remarks
Id
The manifest ID is required and must be unique within the OriginEndpoint.
public virtual string Id { get; set; }
Property Value
System.String
Remarks
The ID can't be changed after the endpoint is created.
ManifestName
A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint.
public virtual string ManifestName { get; set; }
Property Value
System.String
Remarks
MssPackage
Parameters for Microsoft Smooth Streaming packaging.
public virtual object MssPackage { get; set; }
Property Value
System.Object
Remarks
Origination
Controls video origination from this endpoint.
public virtual string Origination { get; set; }
Property Value
System.String
Remarks
StartoverWindowSeconds
Maximum duration (seconds) of content to retain for startover playback.
public virtual Nullable<double> StartoverWindowSeconds { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Omit this attribute or enter 0
to indicate that startover playback is disabled for this endpoint.
Tags
The tags to assign to the endpoint.
public virtual TagManager Tags { get; }
Property Value
Remarks
TimeDelaySeconds
Minimum duration (seconds) of delay to enforce on the playback of live content.
public virtual Nullable<double> TimeDelaySeconds { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Omit this attribute or enter 0
to indicate that there is no time delay in effect for this endpoint.
Whitelist
The IP addresses that can access this endpoint.
public virtual string[] Whitelist { get; set; }
Property Value
System.String[]
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>