View a markdown version of this page

AWS::MediaLive::Input - AWS CloudFormation
SyntaxPropertiesReturn valuesExamples

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::MediaLive::Input

The AWS::MediaLive::Input resource is a MediaLive resource type that creates an input.

A MediaLive input holds information that describes how the MediaLive channel is connected to the upstream system that is providing the source content that is to be transcoded.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::MediaLive::Input",
  "Properties" : {
      "Destinations" : [ InputDestination, ... ],
      "InputDevices" : [ InputDeviceSettings, ... ],
      "InputNetworkLocation" : String,
      "InputSecurityGroups" : [ String, ... ],
      "MediaConnectFlows" : [ MediaConnectFlow, ... ],
      "MulticastSettings" : MulticastSettings,
      "Name" : String,
      "RoleArn" : String,
      "RouterSettings" : RouterSettings,
      "SdiSources" : [ String, ... ],
      "Smpte2110ReceiverGroupSettings" : Smpte2110ReceiverGroupSettings,
      "Sources" : [ InputSource, ... ],
      "SrtSettings" : SrtSettings,
      "Tags" : {Key: Value, ...},
      "Type" : String,
      "Vpc" : InputVpcRequest
    }
}

Properties

Destinations

Settings that apply only if the input is a push type of input.

Required: No

Type: Array of InputDestination

Update requires: No interruption

InputDevices

Settings that apply only if the input is an Elemental Link input.

Required: No

Type: Array of InputDeviceSettings

Update requires: No interruption

InputNetworkLocation

The location of this input. AWS, for an input existing in the AWS Cloud, On-Prem for an input in a customer network.

Required: No

Type: String

Allowed values: AWS | ON_PREMISES

Update requires: Replacement

InputSecurityGroups

The list of input security groups (referenced by IDs) to attach to the input if the input is a push type.

Required: No

Type: Array of String

Update requires: No interruption

MediaConnectFlows

Settings that apply only if the input is a MediaConnect input.

Required: No

Type: Array of MediaConnectFlow

Update requires: No interruption

MulticastSettings

Multicast input settings.

Required: No

Type: MulticastSettings

Update requires: No interruption

Name

A name for the input.

Required: No

Type: String

Update requires: No interruption

RoleArn

The IAM role for MediaLive to assume when creating a MediaConnect input or Amazon VPC input. This doesn't apply to other types of inputs. The role is identified by its ARN.

Required: No

Type: String

Update requires: No interruption

RouterSettings

Settings that apply only if the input is a MEDIACONNECT_ROUTER type of input. Specifies the configuration for MediaConnect router-based content delivery.

Required: No

Type: RouterSettings

Update requires: Replacement

SdiSources

SDI sources for this input.

Required: No

Type: Array of String

Update requires: No interruption

Smpte2110ReceiverGroupSettings

Include this parameter if the input is a SMPTE 2110 input, to identify the stream sources for this input.

Required: No

Type: Smpte2110ReceiverGroupSettings

Update requires: No interruption

Sources

Settings that apply only if the input is a pull type of input.

Required: No

Type: Array of InputSource

Update requires: No interruption

SrtSettings

The settings associated with an SRT input.

Required: No

Type: SrtSettings

Update requires: No interruption

Tags

A collection of tags for this input. Each tag is a key-value pair.

Required: No

Type: Object of String

Pattern: .+

Update requires: No interruption

Type

The type for this input.

Required: No

Type: String

Allowed values: UDP_PUSH | RTP_PUSH | RTMP_PUSH | RTMP_PULL | URL_PULL | MP4_FILE | MEDIACONNECT | INPUT_DEVICE | AWS_CDI | TS_FILE | SRT_CALLER | MULTICAST | SMPTE_2110_RECEIVER_GROUP | SDI | MEDIACONNECT_ROUTER | SRT_LISTENER

Update requires: Replacement

Vpc

Settings that apply only if the input is an push input where the source is on Amazon VPC.

Required: No

Type: InputVpcRequest

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the MediaLive id of the input.

For example: { "Ref": "myInput" }

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The ARN of the MediaLive input. For example: arn:aws:medialive:us-west-1:111122223333:medialive:input:1234567. MediaLive creates this ARN when it creates the input.

AttachedChannels

A list of channel IDs that that input is attached to (currently an input can only be attached to one channel).

Destinations

For a push input, the the destination or destinations for the input. The destinations are the URLs of locations on MediaLive where the upstream system pushes the content to, for this input. MediaLive creates these addresses when it creates the input.

DestinationUrls

Property description not available.

Id

The unique ID for the device.

InputClass

STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails. SINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input.

InputPartnerIds

A list of IDs for all Inputs which are partners of this one.

InputSourceType

Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes during input switch actions. Presently, this functionality only works with MP4_FILE and TS_FILE inputs.

SecurityGroups

A list of IDs for all the Input Security Groups attached to the input.

Sources

For a pull input, the source or sources for the input. The sources are the URLs of locations on the upstream system where MediaLive pulls the content from, for this input. You included these URLs in the create request.

SourceUrls

Property description not available.

State

Property description not available.

Examples

Create a MEDIACONNECT_ROUTER input

This example creates a standard (redundant) MediaLive input that uses MediaConnect as a router for content delivery, with automatic encryption.

JSON

{
  "Type": "AWS::MediaLive::Input",
  "Properties": {
    "Name": "my-router-input",
    "Type": "MEDIACONNECT_ROUTER",
    "RouterSettings": {
      "EncryptionType": "AUTOMATIC",
      "Destinations": [
        {
          "AvailabilityZoneName": "us-east-1a"
        },
        {
          "AvailabilityZoneName": "us-east-1b"
        }
      ]
    }
  }
}

YAML

Type: AWS::MediaLive::Input
Properties:
  Name: my-router-input
  Type: MEDIACONNECT_ROUTER
  RouterSettings:
    EncryptionType: AUTOMATIC
    Destinations:
      - AvailabilityZoneName: us-east-1a
      - AvailabilityZoneName: us-east-1b