Class CfnOriginEndpoint
Specifies the configuration parameters for a MediaPackage V2 origin endpoint.
Inherited Members
Namespace: Amazon.CDK.AwsMediapackagev2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnOriginEndpoint : CfnResource, IInspectable, IOriginEndpointRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2Syntax (vb)
Public Class CfnOriginEndpoint Inherits CfnResource Implements IInspectable, IOriginEndpointRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2Remarks
CloudformationResource: AWS::MediaPackageV2::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_mediapackagev2;
var cfnOriginEndpoint = new CfnOriginEndpoint(this, "MyCfnOriginEndpoint", new CfnOriginEndpointProps {
ChannelGroupName = "channelGroupName",
ChannelName = "channelName",
ContainerType = "containerType",
OriginEndpointName = "originEndpointName",
// the properties below are optional
DashManifests = new [] { new DashManifestConfigurationProperty {
ManifestName = "manifestName",
// the properties below are optional
BaseUrls = new [] { new DashBaseUrlProperty {
Url = "url",
// the properties below are optional
DvbPriority = 123,
DvbWeight = 123,
ServiceLocation = "serviceLocation"
} },
Compactness = "compactness",
DrmSignaling = "drmSignaling",
DvbSettings = new DashDvbSettingsProperty {
ErrorMetrics = new [] { new DashDvbMetricsReportingProperty {
ReportingUrl = "reportingUrl",
// the properties below are optional
Probability = 123
} },
FontDownload = new DashDvbFontDownloadProperty {
FontFamily = "fontFamily",
MimeType = "mimeType",
Url = "url"
}
},
FilterConfiguration = new FilterConfigurationProperty {
ClipStartTime = "clipStartTime",
End = "end",
ManifestFilter = "manifestFilter",
Start = "start",
TimeDelaySeconds = 123
},
ManifestWindowSeconds = 123,
MinBufferTimeSeconds = 123,
MinUpdatePeriodSeconds = 123,
PeriodTriggers = new [] { "periodTriggers" },
Profiles = new [] { "profiles" },
ProgramInformation = new DashProgramInformationProperty {
Copyright = "copyright",
LanguageCode = "languageCode",
MoreInformationUrl = "moreInformationUrl",
Source = "source",
Title = "title"
},
ScteDash = new ScteDashProperty {
AdMarkerDash = "adMarkerDash"
},
SegmentTemplateFormat = "segmentTemplateFormat",
SubtitleConfiguration = new DashSubtitleConfigurationProperty {
TtmlConfiguration = new DashTtmlConfigurationProperty {
TtmlProfile = "ttmlProfile"
}
},
SuggestedPresentationDelaySeconds = 123,
UtcTiming = new DashUtcTimingProperty {
TimingMode = "timingMode",
TimingSource = "timingSource"
}
} },
Description = "description",
ForceEndpointErrorConfiguration = new ForceEndpointErrorConfigurationProperty {
EndpointErrorConditions = new [] { "endpointErrorConditions" }
},
HlsManifests = new [] { new HlsManifestConfigurationProperty {
ManifestName = "manifestName",
// the properties below are optional
ChildManifestName = "childManifestName",
FilterConfiguration = new FilterConfigurationProperty {
ClipStartTime = "clipStartTime",
End = "end",
ManifestFilter = "manifestFilter",
Start = "start",
TimeDelaySeconds = 123
},
ManifestWindowSeconds = 123,
ProgramDateTimeIntervalSeconds = 123,
ScteHls = new ScteHlsProperty {
AdMarkerHls = "adMarkerHls"
},
StartTag = new StartTagProperty {
TimeOffset = 123,
// the properties below are optional
Precise = false
},
Url = "url",
UrlEncodeChildManifest = false
} },
LowLatencyHlsManifests = new [] { new LowLatencyHlsManifestConfigurationProperty {
ManifestName = "manifestName",
// the properties below are optional
ChildManifestName = "childManifestName",
FilterConfiguration = new FilterConfigurationProperty {
ClipStartTime = "clipStartTime",
End = "end",
ManifestFilter = "manifestFilter",
Start = "start",
TimeDelaySeconds = 123
},
ManifestWindowSeconds = 123,
ProgramDateTimeIntervalSeconds = 123,
ScteHls = new ScteHlsProperty {
AdMarkerHls = "adMarkerHls"
},
StartTag = new StartTagProperty {
TimeOffset = 123,
// the properties below are optional
Precise = false
},
Url = "url",
UrlEncodeChildManifest = false
} },
Segment = new SegmentProperty {
Encryption = new EncryptionProperty {
EncryptionMethod = new EncryptionMethodProperty {
CmafEncryptionMethod = "cmafEncryptionMethod",
TsEncryptionMethod = "tsEncryptionMethod"
},
SpekeKeyProvider = new SpekeKeyProviderProperty {
DrmSystems = new [] { "drmSystems" },
EncryptionContractConfiguration = new EncryptionContractConfigurationProperty {
PresetSpeke20Audio = "presetSpeke20Audio",
PresetSpeke20Video = "presetSpeke20Video"
},
ResourceId = "resourceId",
RoleArn = "roleArn",
Url = "url"
},
// the properties below are optional
CmafExcludeSegmentDrmMetadata = false,
ConstantInitializationVector = "constantInitializationVector",
KeyRotationIntervalSeconds = 123
},
IncludeIframeOnlyStreams = false,
Scte = new ScteProperty {
ScteFilter = new [] { "scteFilter" }
},
SegmentDurationSeconds = 123,
SegmentName = "segmentName",
TsIncludeDvbSubtitles = false,
TsUseAudioRenditionGroup = false
},
StartoverWindowSeconds = 123,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});Synopsis
Constructors
| CfnOriginEndpoint(Construct, string, ICfnOriginEndpointProps) | Specifies the configuration parameters for a MediaPackage V2 origin endpoint. |
Properties
| AttrArn | The Amazon Resource Name (ARN) of the origin endpoint. |
| AttrCreatedAt | The timestamp of the creation of the origin endpoint. |
| AttrDashManifestUrls | The egress domain URL for stream delivery from MediaPackage. |
| AttrHlsManifestUrls | The egress domain URL for stream delivery from MediaPackage. |
| AttrLowLatencyHlsManifestUrls | The egress domain URL for stream delivery from MediaPackage. |
| AttrModifiedAt | The timestamp of the modification of the origin endpoint. |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CdkTagManager | Tag Manager which manages the tags for this resource. |
| CfnProperties | Specifies the configuration parameters for a MediaPackage V2 origin endpoint. |
| ChannelGroupName | The name of the channel group associated with the origin endpoint configuration. |
| ChannelName | The channel name associated with the origin endpoint. |
| ContainerType | The container type associated with the origin endpoint configuration. |
| DashManifests | A DASH manifest configuration. |
| Description | The description associated with the origin endpoint. |
| ForceEndpointErrorConfiguration | The failover settings for the endpoint. |
| HlsManifests | The HLS manifests associated with the origin endpoint configuration. |
| LowLatencyHlsManifests | The low-latency HLS (LL-HLS) manifests associated with the origin endpoint. |
| OriginEndpointName | The name of the origin endpoint associated with the origin endpoint configuration. |
| OriginEndpointRef | A reference to a OriginEndpoint resource. |
| Segment | The segment associated with the origin endpoint. |
| StartoverWindowSeconds | The size of the window (in seconds) to specify a window of the live stream that's available for on-demand viewing. |
| Tags | The tags associated with the origin endpoint. |
Methods
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| RenderProperties(IDictionary<string, object>) | Specifies the configuration parameters for a MediaPackage V2 origin endpoint. |
Constructors
CfnOriginEndpoint(Construct, string, ICfnOriginEndpointProps)
Specifies the configuration parameters for a MediaPackage V2 origin endpoint.
public CfnOriginEndpoint(Construct scope, string id, ICfnOriginEndpointProps props)Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnOriginEndpointProps
Resource properties.
Remarks
CloudformationResource: AWS::MediaPackageV2::OriginEndpoint
ExampleMetadata: fixture=_generated
Properties
AttrArn
The Amazon Resource Name (ARN) of the origin endpoint.
public virtual string AttrArn { get; }Property Value
Remarks
CloudformationAttribute: Arn
AttrCreatedAt
The timestamp of the creation of the origin endpoint.
public virtual string AttrCreatedAt { get; }Property Value
Remarks
CloudformationAttribute: CreatedAt
AttrDashManifestUrls
The egress domain URL for stream delivery from MediaPackage.
public virtual string[] AttrDashManifestUrls { get; }Property Value
string[]
Remarks
CloudformationAttribute: DashManifestUrls
AttrHlsManifestUrls
The egress domain URL for stream delivery from MediaPackage.
public virtual string[] AttrHlsManifestUrls { get; }Property Value
string[]
Remarks
CloudformationAttribute: HlsManifestUrls
AttrLowLatencyHlsManifestUrls
The egress domain URL for stream delivery from MediaPackage.
public virtual string[] AttrLowLatencyHlsManifestUrls { get; }Property Value
string[]
Remarks
CloudformationAttribute: LowLatencyHlsManifestUrls
AttrModifiedAt
The timestamp of the modification of the origin endpoint.
public virtual string AttrModifiedAt { get; }Property Value
Remarks
CloudformationAttribute: ModifiedAt
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }Property Value
Remarks
CloudformationResource: AWS::MediaPackageV2::OriginEndpoint
ExampleMetadata: fixture=_generated
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }Property Value
Remarks
CloudformationResource: AWS::MediaPackageV2::OriginEndpoint
ExampleMetadata: fixture=_generated
CfnProperties
Specifies the configuration parameters for a MediaPackage V2 origin endpoint.
protected override IDictionary<string, object> CfnProperties { get; }Property Value
Overrides
Remarks
CloudformationResource: AWS::MediaPackageV2::OriginEndpoint
ExampleMetadata: fixture=_generated
ChannelGroupName
The name of the channel group associated with the origin endpoint configuration.
public virtual string ChannelGroupName { get; set; }Property Value
Remarks
CloudformationResource: AWS::MediaPackageV2::OriginEndpoint
ExampleMetadata: fixture=_generated
ChannelName
The channel name associated with the origin endpoint.
public virtual string ChannelName { get; set; }Property Value
Remarks
CloudformationResource: AWS::MediaPackageV2::OriginEndpoint
ExampleMetadata: fixture=_generated
ContainerType
The container type associated with the origin endpoint configuration.
public virtual string ContainerType { get; set; }Property Value
Remarks
CloudformationResource: AWS::MediaPackageV2::OriginEndpoint
ExampleMetadata: fixture=_generated
DashManifests
A DASH manifest configuration.
public virtual object? DashManifests { get; set; }Property Value
Remarks
Type union: either IResolvable or (either IResolvable or CfnOriginEndpoint.IDashManifestConfigurationProperty)[]
Description
The description associated with the origin endpoint.
public virtual string? Description { get; set; }Property Value
Remarks
CloudformationResource: AWS::MediaPackageV2::OriginEndpoint
ExampleMetadata: fixture=_generated
ForceEndpointErrorConfiguration
The failover settings for the endpoint.
public virtual object? ForceEndpointErrorConfiguration { get; set; }Property Value
Remarks
Type union: either IResolvable or CfnOriginEndpoint.IForceEndpointErrorConfigurationProperty
HlsManifests
The HLS manifests associated with the origin endpoint configuration.
public virtual object? HlsManifests { get; set; }Property Value
Remarks
Type union: either IResolvable or (either IResolvable or CfnOriginEndpoint.IHlsManifestConfigurationProperty)[]
LowLatencyHlsManifests
The low-latency HLS (LL-HLS) manifests associated with the origin endpoint.
public virtual object? LowLatencyHlsManifests { get; set; }Property Value
Remarks
Type union: either IResolvable or (either IResolvable or CfnOriginEndpoint.ILowLatencyHlsManifestConfigurationProperty)[]
OriginEndpointName
The name of the origin endpoint associated with the origin endpoint configuration.
public virtual string OriginEndpointName { get; set; }Property Value
Remarks
CloudformationResource: AWS::MediaPackageV2::OriginEndpoint
ExampleMetadata: fixture=_generated
OriginEndpointRef
A reference to a OriginEndpoint resource.
public virtual IOriginEndpointReference OriginEndpointRef { get; }Property Value
Remarks
CloudformationResource: AWS::MediaPackageV2::OriginEndpoint
ExampleMetadata: fixture=_generated
Segment
The segment associated with the origin endpoint.
public virtual object? Segment { get; set; }Property Value
Remarks
Type union: either IResolvable or CfnOriginEndpoint.ISegmentProperty
StartoverWindowSeconds
The size of the window (in seconds) to specify a window of the live stream that's available for on-demand viewing.
public virtual double? StartoverWindowSeconds { get; set; }Property Value
Remarks
CloudformationResource: AWS::MediaPackageV2::OriginEndpoint
ExampleMetadata: fixture=_generated
Tags
The tags associated with the origin endpoint.
public virtual ICfnTag[]? Tags { get; set; }Property Value
ICfnTag[]
Remarks
CloudformationResource: AWS::MediaPackageV2::OriginEndpoint
ExampleMetadata: fixture=_generated
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.
Remarks
CloudformationResource: AWS::MediaPackageV2::OriginEndpoint
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
Specifies the configuration parameters for a MediaPackage V2 origin endpoint.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
CloudformationResource: AWS::MediaPackageV2::OriginEndpoint
ExampleMetadata: fixture=_generated