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
ts
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,
});
python
from aws_cdk.aws_ssm import StringParameter
# bucket: s3.IBucket
# password_param: StringParameter
# From an S3 bucket — the channel role is granted read access automatically
from_s3 = medialive.FileLocation.from_bucket(bucket, "assets/slate.png")
# From a URL with optional credentials (SSM parameter read access auto-granted)
from_url = medialive.FileLocation.url("https://origin.example.com/font.ttf",
username="ingest-user",
password=password_param
)
java
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());
csharp
// Install: dotnet add package Amazon.CDK.AWS.MediaLive.Alpha
using Amazon.CDK.AWS.SSM;
IBucket bucket;
StringParameter passwordParam;
// From an S3 bucket — the channel role is granted read access automatically
var fromS3 = FileLocation.FromBucket(bucket, "assets/slate.png");
// From a URL with optional credentials (SSM parameter read access auto-granted)
var fromUrl = FileLocation.Url("https://origin.example.com/font.ttf", new FileLocationOptions {
Username = "ingest-user",
Password = passwordParam
});
go
// Install: go get github.com/aws/aws-cdk-go/awsmedialivealpha/v2
import "github.com/aws/aws-cdk-go/awscdk"
var bucket IBucket
var passwordParam StringParameter
// From an S3 bucket — the channel role is granted read access automatically
fromS3 := medialive.FileLocation_FromBucket(bucket, jsii.String("assets/slate.png"))
// From a URL with optional credentials (SSM parameter read access auto-granted)
fromUrl := medialive.FileLocation_Url(jsii.String("https://origin.example.com/font.ttf"), &FileLocationOptions{
Username: jsii.String("ingest-user"),
Password: passwordParam,
})
Properties
passwordoptionalIStringParameterpasswordoptionalIStringParameterpasswordoptionalIStringParameterPasswordoptionalIStringParameterPasswordoptionalIStringParameter #The SSM parameter that holds the password for accessing the upstream system.
Default: no credentials
The channel role is granted read access to the parameter automatically.
usernameoptionalstringusernameoptionalstrusernameoptionalStringUsernameoptionalstringUsernameoptional*string #The username for accessing the upstream system.
Default: no credentials