Skip to content
v2.278.0

Experimental

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

ArchiveOutputDefinition Struct ​

Output definition for an Archive output group.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as medialive_alpha from '@aws-cdk/aws-medialive-alpha';

declare const archiveContainer: medialive_alpha.ArchiveContainer;
declare const encodeConfiguration: medialive_alpha.EncodeConfiguration;
const archiveOutputDefinition: medialive_alpha.ArchiveOutputDefinition = {
  encodes: [encodeConfiguration],
  outputName: 'outputName',

  // the properties below are optional
  container: archiveContainer,
  extension: 'extension',
  nameModifier: 'nameModifier',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_medialive_alpha as medialive_alpha

# archive_container: medialive_alpha.ArchiveContainer
# encode_configuration: medialive_alpha.EncodeConfiguration

archive_output_definition = medialive_alpha.ArchiveOutputDefinition(
    encodes=[encode_configuration],
    output_name="outputName",

    # the properties below are optional
    container=archive_container,
    extension="extension",
    name_modifier="nameModifier"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.medialive.alpha.*;

ArchiveContainer archiveContainer;
EncodeConfiguration encodeConfiguration;

ArchiveOutputDefinition archiveOutputDefinition = ArchiveOutputDefinition.builder()
        .encodes(List.of(encodeConfiguration))
        .outputName("outputName")

        // the properties below are optional
        .container(archiveContainer)
        .extension("extension")
        .nameModifier("nameModifier")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.MediaLive.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.MediaLive.Alpha;

ArchiveContainer archiveContainer;
EncodeConfiguration encodeConfiguration;

var archiveOutputDefinition = new ArchiveOutputDefinition {
    Encodes = new [] { encodeConfiguration },
    OutputName = "outputName",

    // the properties below are optional
    Container = archiveContainer,
    Extension = "extension",
    NameModifier = "nameModifier"
};
go
// Install: go get github.com/aws/aws-cdk-go/awsmedialivealpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import medialive_alpha "github.com/aws/aws-cdk-go/awsmedialivealpha"

var archiveContainer ArchiveContainer
var encodeConfiguration EncodeConfiguration

archiveOutputDefinition := &ArchiveOutputDefinition{
	Encodes: []EncodeConfiguration{
		encodeConfiguration,
	},
	OutputName: jsii.String("outputName"),

	// the properties below are optional
	Container: archiveContainer,
	Extension: jsii.String("extension"),
	NameModifier: jsii.String("nameModifier"),
}

Properties ​

containeroptionalArchiveContainercontaineroptionalArchiveContainercontaineroptionalArchiveContainerContaineroptionalArchiveContainerContaineroptionalArchiveContainer #
The container (transport stream) for this output — an MPEG-TS (M2TS) or raw container.

Default: ArchiveContainer.m2ts() with service-default M2TS settings

Use the ArchiveContainer factory methods.

encodesEncodeConfiguration[]encodestyping.List[EncodeConfiguration]encodesList<EncodeConfiguration>EncodesEncodeConfiguration[]Encodes*[]EncodeConfiguration required #
The encode configurations to wire to this output.
extensionoptionalstringextensionoptionalstrextensionoptionalStringExtensionoptionalstringExtensionoptional*string #
The output file extension.

Default: auto-selected from container type

nameModifieroptionalstringname_modifieroptionalstrnameModifieroptionalStringNameModifieroptionalstringNameModifieroptional*string #
A string concatenated to the end of the destination file name.

Default: no name modifier

Required if the output group contains more than one output of the same container type.

outputNamestringoutput_namestroutputNameStringOutputNamestringOutputName*string required #
The name of this output.

Must be unique across all outputs in the channel.