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

Interface FileLocationOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

FileLocationOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:41.054Z")
@Stability(Experimental)
public interface FileLocationOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for a URL-based file location (FileLocation.url).

Example:

 import software.amazon.awscdk.services.ssm.StringParameter;
 IBucket bucket;
 StringParameter passwordParam;
 // From an S3 bucket — the channel role is granted read access automatically
 FileLocation fromS3 = FileLocation.fromBucket(bucket, "assets/slate.png");
 // From a URL with optional credentials (SSM parameter read access auto-granted)
 FileLocation fromUrl = FileLocation.url("https://origin.example.com/font.ttf", FileLocationOptions.builder()
         .username("ingest-user")
         .password(passwordParam)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	FileLocationOptions.Builder	A builder for FileLocationOptions
static final class	FileLocationOptions.Jsii$Proxy	An implementation for FileLocationOptions

Method Summary

Modifier and Type	Method	Description
static FileLocationOptions.Builder	builder()
default IStringParameter	getPassword()	(experimental) The SSM parameter that holds the password for accessing the upstream system.
default String	getUsername()	(experimental) The username for accessing the upstream system.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPassword

@Stability(Experimental)
@Nullable
default IStringParameter getPassword()

(experimental) The SSM parameter that holds the password for accessing the upstream system.

The channel role is granted read access to the parameter automatically.

Default: - no credentials

getUsername

@Stability(Experimental)
@Nullable
default String getUsername()

(experimental) The username for accessing the upstream system.

Default: - no credentials

builder

@Stability(Experimental)
static FileLocationOptions.Builder builder()

Returns:

a FileLocationOptions.Builder of FileLocationOptions