aws-cdk-lib.aws_mediatailor.CfnPlaybackConfiguration.ClientSideBeaconingConfigurationProperty

ClientSideBeaconingConfigurationProperty Struct

The beaconing settings that apply to client-side reporting sessions: whether AWS Elemental MediaTailor includes its beacons in the ad tracking response, and which player operation events it reports on.

If you omit this object, MediaTailor uses INSIGHTS reporting mode.

Source

Generated code

Type last changed

v2.274.0 · 20 Oct 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_mediatailor as mediatailor } from 'aws-cdk-lib';
const clientSideBeaconingConfigurationProperty: mediatailor.CfnPlaybackConfiguration.ClientSideBeaconingConfigurationProperty = {
  reportingMode: 'reportingMode',

  // the properties below are optional
  additionalEventTypes: ['additionalEventTypes'],
};

Properties

additionalEventTypes?optionalstring[]additional_event_types?optionaltyping.List[str]additionalEventTypes?optionalList<String>AdditionalEventTypes?optionalstring[]AdditionalEventTypes?optional*[]*string#

The player operation events to report on, in addition to the ad progress events that MediaTailor always reports on.

notes

Valid values are MUTE, UNMUTE, PAUSE, and SKIP. The default is an empty list. This parameter is valid only when ReportingMode is INSIGHTS. MediaTailor rejects the request if you specify a value while ReportingMode is DISABLED, or if you specify duplicate values.

reportingModestringreporting_modestrreportingModeStringReportingModestringReportingMode*stringrequired#

Specifies whether MediaTailor includes its beacons in the ad tracking response.

notes

INSIGHTS includes MediaTailor beacons; DISABLED does not. Values are case-sensitive. This setting is required when ClientSide is present. If BeaconingConfiguration or ClientSide is omitted, MediaTailor uses INSIGHTS. To keep beaconing off, retain DISABLED in subsequent updates.