Package software.amazon.awscdk.services.medialive.alpha

Class FileLocation

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.medialive.alpha.FileLocation
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:41.053Z") @Stability(Experimental) public abstract class FileLocation extends software.amazon.jsii.JsiiObject
(experimental) A reference to a file MediaLive reads at runtime — for example an input-loss slate image, an avail-blanking image, a burn-in caption font, or a color-correction LUT.

Use the static factory methods to create one from an S3 bucket (which auto-grants the channel role read access) or from a raw URL.

Example: 

 IBucket bucket;
 EncodeConfiguration video;
 EncodeConfiguration audio;
 OutputGroupConfiguration.hls(HlsOutputGroupProps.builder()
         .name("hls")
         .destinations(List.of(OutputDestination.toBucket(bucket, "live/stream")))
         .outputs(List.of(HlsOutputDefinition.builder()
                 .encodes(List.of(video))
                 .outputName("video")
                 .hlsSettings(HlsSettings.standard(StandardHlsSettingsProps.builder()
                         .m3u8Settings(M3u8Settings.of(M3u8SettingsProps.builder()
                                 .scte35Behavior(M3u8Scte35Behavior.PASSTHROUGH)
                                 .programNum(1)
                                 .build()))
                         .build()))
                 .build(), HlsOutputDefinition.builder()
                 .encodes(List.of(audio))
                 .outputName("audio")
                 .hlsSettings(HlsSettings.audioOnly(AudioOnlyHlsSettingsProps.builder()
                         .audioGroupId("program")
                         .audioOnlyImage(FileLocation.fromBucket(bucket, "art/cover.png"))
                         .build()))
                 .build()))
         .build());

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    FileLocation()
     
    protected
    FileLocation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    FileLocation(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static FileLocation
    fromBucket(IBucket bucket, String key)
    (experimental) Reference a file in an S3 bucket.
    static FileLocation
    url(String url)
    (experimental) Reference a file by URL (e.g.
    static FileLocation
    url(String url, FileLocationOptions options)
    (experimental) Reference a file by URL (e.g.

    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, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • FileLocation

      protected FileLocation(software.amazon.jsii.JsiiObjectRef objRef)

    • FileLocation

      protected FileLocation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • FileLocation

      @Stability(Experimental) protected FileLocation()

  • Method Details

    • fromBucket

      @Stability(Experimental) @NotNull public static FileLocation fromBucket(@NotNull IBucket bucket, @NotNull String key)
      (experimental) Reference a file in an S3 bucket.

      Automatically grants the channel role read access.

      Parameters:
      bucket - The S3 bucket containing the file. This parameter is required.
      key - The object key within the bucket (e.g. 'slates/offline.png'). This parameter is required.

    • url

      @Stability(Experimental) @NotNull public static FileLocation url(@NotNull String url, @Nullable FileLocationOptions options)
      (experimental) Reference a file by URL (e.g. an https:// endpoint or an s3ssl:// path).

      Parameters:
      url - The URL MediaLive reads the file from. This parameter is required.
      options - Optional credentials.

    • url

      @Stability(Experimental) @NotNull public static FileLocation url(@NotNull String url)
      (experimental) Reference a file by URL (e.g. an https:// endpoint or an s3ssl:// path).

      Parameters:
      url - The URL MediaLive reads the file from. This parameter is required.