@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
148 lines (147 loc) • 5.52 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource for managing an AWS MediaLive MultiplexProgram.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const available = aws.getAvailabilityZones({
* state: "available",
* });
* const example = new aws.medialive.Multiplex("example", {
* name: "example-multiplex-changed",
* availabilityZones: [
* available.then(available => available.names?.[0]),
* available.then(available => available.names?.[1]),
* ],
* multiplexSettings: {
* transportStreamBitrate: 1000000,
* transportStreamId: 1,
* transportStreamReservedBitrate: 1,
* maximumVideoBufferDelayMilliseconds: 1000,
* },
* startMultiplex: true,
* tags: {
* tag1: "value1",
* },
* });
* const exampleMultiplexProgram = new aws.medialive.MultiplexProgram("example", {
* programName: "example_program",
* multiplexId: example.id,
* multiplexProgramSettings: {
* programNumber: 1,
* preferredChannelPipeline: "CURRENTLY_ACTIVE",
* videoSettings: {
* constantBitrate: 100000,
* },
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import MediaLive MultiplexProgram using the `id`, or a combination of "`program_name`/`multiplex_id`". For example:
*
* ```sh
* $ pulumi import aws:medialive/multiplexProgram:MultiplexProgram example example_program/1234567
* ```
*/
export declare class MultiplexProgram extends pulumi.CustomResource {
/**
* Get an existing MultiplexProgram resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: MultiplexProgramState, opts?: pulumi.CustomResourceOptions): MultiplexProgram;
/**
* Returns true if the given object is an instance of MultiplexProgram. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is MultiplexProgram;
/**
* Multiplex ID.
*/
readonly multiplexId: pulumi.Output<string>;
/**
* MultiplexProgram settings. See Multiplex Program Settings for more details.
*
* The following arguments are optional:
*/
readonly multiplexProgramSettings: pulumi.Output<outputs.medialive.MultiplexProgramMultiplexProgramSettings | undefined>;
/**
* Unique program name.
*/
readonly programName: pulumi.Output<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
readonly timeouts: pulumi.Output<outputs.medialive.MultiplexProgramTimeouts | undefined>;
/**
* Create a MultiplexProgram resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: MultiplexProgramArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering MultiplexProgram resources.
*/
export interface MultiplexProgramState {
/**
* Multiplex ID.
*/
multiplexId?: pulumi.Input<string>;
/**
* MultiplexProgram settings. See Multiplex Program Settings for more details.
*
* The following arguments are optional:
*/
multiplexProgramSettings?: pulumi.Input<inputs.medialive.MultiplexProgramMultiplexProgramSettings>;
/**
* Unique program name.
*/
programName?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
timeouts?: pulumi.Input<inputs.medialive.MultiplexProgramTimeouts>;
}
/**
* The set of arguments for constructing a MultiplexProgram resource.
*/
export interface MultiplexProgramArgs {
/**
* Multiplex ID.
*/
multiplexId: pulumi.Input<string>;
/**
* MultiplexProgram settings. See Multiplex Program Settings for more details.
*
* The following arguments are optional:
*/
multiplexProgramSettings?: pulumi.Input<inputs.medialive.MultiplexProgramMultiplexProgramSettings>;
/**
* Unique program name.
*/
programName: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
timeouts?: pulumi.Input<inputs.medialive.MultiplexProgramTimeouts>;
}