AWS CDK Reference

Appearance

v2.275.0

Experimental

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

ArchiveOutputGroupProps Struct ​

Properties for an Archive (S3) output group.

Stability
Experimental
Source
lib/output-group.ts

Example ​

ts
declare const bucket: s3.IBucket;
declare const video: medialive.EncodeConfiguration;
declare const audio: medialive.EncodeConfiguration;

medialive.OutputGroupConfiguration.archive({
  name: 'archive',
  destinations: [medialive.S3OutputDestination.toBucket(bucket, 'archive/recording')],
  rolloverInterval: Duration.seconds(600),
  outputs: [{ encodes: [video, audio], outputName: 'archive_out' }],
});

Properties ​

archiveS3CannedAcloptionalS3CannedAclarchive_s3_canned_acloptionalS3CannedAclarchiveS3CannedAcloptionalS3CannedAclArchiveS3CannedAcloptionalS3CannedAclArchiveS3CannedAcloptionalS3CannedAcl#
The S3 canned ACL to apply to each archive output.

Default: no canned ACL

destinationsS3OutputDestination[]destinationstyping.List[S3OutputDestination]destinationsList<S3OutputDestination>DestinationsS3OutputDestination[]Destinations*[]S3OutputDestinationrequired#
The destinations for this output group — one per pipeline.
notes

Array position determines the pipeline mapping:

  • destinations[0] → Pipeline 0
  • destinations[1] → Pipeline 1 (STANDARD channels only)

For a SINGLE_PIPELINE channel, provide exactly 1 destination. For a STANDARD channel, provide exactly 2 destinations.

namestringnamestrnameStringNamestringName*stringrequired#
The name of this output group.

Used as the destination reference ID. Underscores are normalised to hyphens internally.

outputsoptionalArchiveOutputDefinition[]outputsoptionaltyping.List[ArchiveOutputDefinition]outputsoptionalList<ArchiveOutputDefinition>OutputsoptionalArchiveOutputDefinition[]Outputsoptional*[]ArchiveOutputDefinition#
The outputs for this Archive output group.

Default: no initial outputs

rolloverIntervaloptionalDurationrollover_intervaloptionalDurationrolloverIntervaloptionalDurationRolloverIntervaloptionalDurationRolloverIntervaloptionalDuration= Duration.seconds(300)#
The duration of each archive file (rollover interval).