@aws-cdk/aws-medialive-alpha.FileLocationOptions

Experimental

@aws-cdk/aws-medialive-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

FileLocationOptions Struct

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

Stability

Experimental

Source

lib/file-location.ts

Example

import { StringParameter } from 'aws-cdk-lib/aws-ssm';

declare const bucket: s3.IBucket;
declare const passwordParam: StringParameter;

// From an S3 bucket — the channel role is granted read access automatically
const fromS3 = medialive.FileLocation.fromBucket(bucket, 'assets/slate.png');

// From a URL with optional credentials (SSM parameter read access auto-granted)
const fromUrl = medialive.FileLocation.url('https://origin.example.com/font.ttf', {
  username: 'ingest-user',
  password: passwordParam,
});

Properties

passwordIStringParameterpasswordIStringParameterpasswordIStringParameterPasswordIStringParameterPasswordIStringParameter= no credentials#

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

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

usernamestringusernamestrusernameStringUsernamestringUsername*string= no credentials#

The username for accessing the upstream system.