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

Experimental

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

PoisEndpoint Struct

Connection details for an ESAM POIS (Placement Opportunity Information System) endpoint.

Stability

Experimental

Source

lib/avail-settings.ts

Example

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

declare const stack: Stack;
declare const input: medialive.IInput;
declare const bucket: s3.IBucket;
declare const video: medialive.EncodeConfiguration;
declare const poisPassword: StringParameter;

new medialive.Channel(stack, 'Channel', {
  inputs: [{ input }],
  availSettings: medialive.AvailSettings.esam({
    pois: {
      url: 'https://pois.example.com/esam',
      username: 'pois-user',
      password: poisPassword,
    },
    acquisitionPointId: 'acquisition-point-1',
    adAvailOffset: Duration.millis(200),
  }),
  scte35SegmentationScope: medialive.Scte35SegmentationScope.SCTE35_ENABLED_OUTPUT_GROUPS,
  outputGroups: [
    medialive.OutputGroupConfiguration.hls({
      name: 'hls',
      destinations: [medialive.OutputDestination.toBucket(bucket, 'live/stream')],
      outputs: [{ encodes: [video], outputName: 'hls_out' }],
    }),
  ],
});

Properties

passwordIStringParameterpasswordIStringParameterpasswordIStringParameterPasswordIStringParameterPasswordIStringParameter= no credentials#

An SSM parameter holding the password for the POIS endpoint.

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

urlstringurlstrurlStringUrlstringUrl*stringrequired#

The POIS endpoint URL that MediaLive sends signal conditioning information to.

usernamestringusernamestrusernameStringUsernamestringUsername*string= no credentials#

The username used to connect to the POIS endpoint.