CfnOriginEndpointProps (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnOriginEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.927Z")
 @Stability(value=Stable)
public interface CfnOriginEndpointProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnOriginEndpoint`.

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.*;
 CfnOriginEndpointProps cfnOriginEndpointProps = CfnOriginEndpointProps.builder()
         .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	Interface and Description
`static class`	`CfnOriginEndpointProps.Builder` A builder for `CfnOriginEndpointProps`
`static class`	`CfnOriginEndpointProps.Jsii$Proxy` An implementation for `CfnOriginEndpointProps`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static CfnOriginEndpointProps.Builder`	`builder()`
`default Object`	`getAuthorization()` Parameters for CDN authorization.
`String`	`getChannelId()` The ID of the channel associated with this endpoint.
`default Object`	`getCmafPackage()` Parameters for Common Media Application Format (CMAF) packaging.
`default Object`	`getDashPackage()` Parameters for DASH packaging.
`default String`	`getDescription()` Any descriptive information that you want to add to the endpoint for future identification purposes.
`default Object`	`getHlsPackage()` Parameters for Apple HLS packaging.
`String`	`getId()` The manifest ID is required and must be unique within the OriginEndpoint.
`default String`	`getManifestName()` A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint.
`default Object`	`getMssPackage()` Parameters for Microsoft Smooth Streaming packaging.
`default String`	`getOrigination()` Controls video origination from this endpoint.
`default Number`	`getStartoverWindowSeconds()` Maximum duration (seconds) of content to retain for startover playback.
`default List<CfnTag>`	`getTags()` The tags to assign to the endpoint.
`default Number`	`getTimeDelaySeconds()` Minimum duration (seconds) of delay to enforce on the playback of live content.
`default List<String>`	`getWhitelist()` The IP addresses that can access this endpoint.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getChannelId
```
@Stability(value=Stable)
 @NotNull
String getChannelId()
```
    The ID of the channel associated with this endpoint.
  - getId
```
@Stability(value=Stable)
 @NotNull
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.
  - getAuthorization
```
@Stability(value=Stable)
 @Nullable
default Object getAuthorization()
```
    Parameters for CDN authorization.
  - getCmafPackage
```
@Stability(value=Stable)
 @Nullable
default Object getCmafPackage()
```
    Parameters for Common Media Application Format (CMAF) packaging.
  - getDashPackage
```
@Stability(value=Stable)
 @Nullable
default Object getDashPackage()
```
    Parameters for DASH packaging.
  - getDescription
```
@Stability(value=Stable)
 @Nullable
default String getDescription()
```
    Any descriptive information that you want to add to the endpoint for future identification purposes.
  - getHlsPackage
```
@Stability(value=Stable)
 @Nullable
default Object getHlsPackage()
```
    Parameters for Apple HLS packaging.
  - getManifestName
```
@Stability(value=Stable)
 @Nullable
default String getManifestName()
```
    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
default Object getMssPackage()
```
    Parameters for Microsoft Smooth Streaming packaging.
  - getOrigination
```
@Stability(value=Stable)
 @Nullable
default 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 .
  - getStartoverWindowSeconds
```
@Stability(value=Stable)
 @Nullable
default 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.
  - getTags
```
@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()
```
    The tags to assign to the endpoint.
  - getTimeDelaySeconds
```
@Stability(value=Stable)
 @Nullable
default 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
  - getWhitelist
```
@Stability(value=Stable)
 @Nullable
default List<String> getWhitelist()
```
    The IP addresses that can access this endpoint.
  - builder
```
@Stability(value=Stable)
static CfnOriginEndpointProps.Builder builder()
```
    Returns:
    
    a CfnOriginEndpointProps.Builder of CfnOriginEndpointProps

Interface CfnOriginEndpointProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getChannelId

getId

getAuthorization

getCmafPackage

getDashPackage

getDescription

getHlsPackage

getManifestName

getMssPackage

getOrigination

getStartoverWindowSeconds

getTags

getTimeDelaySeconds

getWhitelist

builder