Resource schema for AWS::MediaConnect::FlowMediaStream. A media stream represents a single track or stream of media containing video, audio, or ancillary data that is transported using the SMPTE 2110 JPEG XS or CDI protocol.
Create FlowMediaStream Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
@overload
def FlowMediaStream(resource_name: str,
args: FlowMediaStreamInitArgs,
opts: Optional[ResourceOptions] = None)
@overload
def FlowMediaStream(resource_name: str,
opts: Optional[ResourceOptions] = None,
flow_arn: Optional[str] = None,
media_stream_id: Optional[int] = None,
media_stream_type: Optional[FlowMediaStreamMediaStreamType] = None,
attributes: Optional[FlowMediaStreamMediaStreamAttributesArgs] = None,
clock_rate: Optional[int] = None,
description: Optional[str] = None,
media_stream_name: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
video_format: Optional[str] = None)
type: aws-native:mediaconnect:FlowMediaStream
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_mediaconnect_flow_media_stream" "name" {
# resource properties
}
Parameters
- ctx
Context
- Context object for the current deployment.
- name
string
- The unique name of the resource.
- args
FlowMediaStreamArgs
- The arguments to resource properties.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resource.
- args
FlowMediaStreamArgs
- The arguments to resource properties.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
FlowMediaStream Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The FlowMediaStream resource accepts the following input properties:
- FlowArn
string
- The Amazon Resource Name (ARN) of the flow that the media stream belongs to.
- MediaStreamId
int
- A unique identifier for the media stream.
- MediaStreamType
FlowMediaStreamMediaStreamType
- The type of media stream.
- Attributes
FlowMediaStreamMediaStreamAttributesArgs
- ClockRate
int
- The sample rate (in Hz) for the stream. If the media stream type is video or ancillary data, set this value to 90000. If the media stream type is audio, set this value to either 48000 or 96000.
- Description
string
- A description that can help you quickly identify what your media stream is used for.
- MediaStreamName
string
- A name that helps you distinguish one media stream from another.
- Tags
TagArgs
- The key-value pairs that can be used to tag and organize the media stream.
- VideoFormat
string
- The resolution of the video. Required for a video media stream and rejected for other media stream types.
- flow_arn
string
- The Amazon Resource Name (ARN) of the flow that the media stream belongs to.
- media_stream_id
number
- A unique identifier for the media stream.
- media_stream_type
"video" | "audio" | "ancillary-data"
- The type of media stream.
- attributes
object
- clock_rate
number
- The sample rate (in Hz) for the stream. If the media stream type is video or ancillary data, set this value to 90000. If the media stream type is audio, set this value to either 48000 or 96000.
- description
string
- A description that can help you quickly identify what your media stream is used for.
- media_stream_name
string
- A name that helps you distinguish one media stream from another.
- tags
list(object)
- The key-value pairs that can be used to tag and organize the media stream.
- video_format
string
- The resolution of the video. Required for a video media stream and rejected for other media stream types.
- flowArn
String
- The Amazon Resource Name (ARN) of the flow that the media stream belongs to.
- mediaStreamId
Integer
- A unique identifier for the media stream.
- mediaStreamType
FlowMediaStreamMediaStreamType
- The type of media stream.
- attributes
FlowMediaStreamMediaStreamAttributes
- clockRate
Integer
- The sample rate (in Hz) for the stream. If the media stream type is video or ancillary data, set this value to 90000. If the media stream type is audio, set this value to either 48000 or 96000.
- description
String
- A description that can help you quickly identify what your media stream is used for.
- mediaStreamName
String
- A name that helps you distinguish one media stream from another.
- tags
List<Tag>
- The key-value pairs that can be used to tag and organize the media stream.
- videoFormat
String
- The resolution of the video. Required for a video media stream and rejected for other media stream types.
- flowArn
string
- The Amazon Resource Name (ARN) of the flow that the media stream belongs to.
- mediaStreamId
number
- A unique identifier for the media stream.
- mediaStreamType
FlowMediaStreamMediaStreamType
- The type of media stream.
- attributes
FlowMediaStreamMediaStreamAttributes
- clockRate
number
- The sample rate (in Hz) for the stream. If the media stream type is video or ancillary data, set this value to 90000. If the media stream type is audio, set this value to either 48000 or 96000.
- description
string
- A description that can help you quickly identify what your media stream is used for.
- mediaStreamName
string
- A name that helps you distinguish one media stream from another.
- tags
Tag[]
- The key-value pairs that can be used to tag and organize the media stream.
- videoFormat
string
- The resolution of the video. Required for a video media stream and rejected for other media stream types.
- flowArn
String
- The Amazon Resource Name (ARN) of the flow that the media stream belongs to.
- mediaStreamId
Number
- A unique identifier for the media stream.
- mediaStreamType
"video" | "audio" | "ancillary-data"
- The type of media stream.
- attributes
Property Map
- clockRate
Number
- The sample rate (in Hz) for the stream. If the media stream type is video or ancillary data, set this value to 90000. If the media stream type is audio, set this value to either 48000 or 96000.
- description
String
- A description that can help you quickly identify what your media stream is used for.
- mediaStreamName
String
- A name that helps you distinguish one media stream from another.
- tags
List<Property Map>
- The key-value pairs that can be used to tag and organize the media stream.
- videoFormat
String
- The resolution of the video. Required for a video media stream and rejected for other media stream types.
Outputs
All input properties are implicitly available as output properties. Additionally, the FlowMediaStream resource produces the following output properties:
- Arn
string
- The Amazon Resource Name (ARN) of the media stream, composed of the flow ARN followed by /mediaStream/ and the media stream name.
- Fmt
int
- The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream.
- Id
string
- The provider-assigned unique ID for this managed resource.
- Arn
string
- The Amazon Resource Name (ARN) of the media stream, composed of the flow ARN followed by /mediaStream/ and the media stream name.
- Fmt
int
- The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream.
- Id
string
- The provider-assigned unique ID for this managed resource.
- arn
string
- The Amazon Resource Name (ARN) of the media stream, composed of the flow ARN followed by /mediaStream/ and the media stream name.
- fmt
number
- The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream.
- id
string
- The provider-assigned unique ID for this managed resource.
- arn
String
- The Amazon Resource Name (ARN) of the media stream, composed of the flow ARN followed by /mediaStream/ and the media stream name.
- fmt
Integer
- The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream.
- id
String
- The provider-assigned unique ID for this managed resource.
- arn
string
- The Amazon Resource Name (ARN) of the media stream, composed of the flow ARN followed by /mediaStream/ and the media stream name.
- fmt
number
- The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream.
- id
string
- The provider-assigned unique ID for this managed resource.
- arn
str
- The Amazon Resource Name (ARN) of the media stream, composed of the flow ARN followed by /mediaStream/ and the media stream name.
- fmt
int
- The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream.
- id
str
- The provider-assigned unique ID for this managed resource.
- arn
String
- The Amazon Resource Name (ARN) of the media stream, composed of the flow ARN followed by /mediaStream/ and the media stream name.
- fmt
Number
- The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream.
- id
String
- The provider-assigned unique ID for this managed resource.
Look up Existing FlowMediaStream Resource
Get an existing FlowMediaStream resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
func GetFlowMediaStream(ctx *Context, name string, id IDInput, state *FlowMediaStreamState, opts ...ResourceOption) (*FlowMediaStream, error)
public static FlowMediaStream get(String name, Output<String> id, CustomResourceOptions options)
resources: existingFlowMediaStream: type: aws-native:mediaconnect:FlowMediaStream get: id: ${id}
import {
to = aws-native_mediaconnect_flow_media_stream.example
id = "${id}"
}
- name
string
- The unique name of the resulting resource.
- id
Input<ID>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
str
- The unique name of the resulting resource.
- id
str
- The unique provider ID of the resource to look up.
- opts
ResourceOptions
- Bag of options to control resource's behavior.
- ctx
Context
- Context object for the current deployment.
- name
string
- The unique name of the resulting resource.
- id
IDInput
- The unique provider ID of the resource to look up.
- state
FlowMediaStreamState
- Pass nil. This resource has no state arguments.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
string
- The unique name of the resulting resource.
- id
Input<string>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resulting resource.
- id
Output<String>
- The unique provider ID of the resource to look up.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
A set of parameters that define the media stream.
The format used for the representation of color.
| Name | Value |
|---|
| Bt601 | BT601 |
| Bt709 | BT709 |
| Bt2020 | BT2020 |
| Bt2100 | BT2100 |
| St20651 | ST2065-1 |
| St20653 | ST2065-3 |
| Xyz | XYZ |
| Name | Value |
|---|
| FlowMediaStreamFmtpColorimetryBt601 | BT601 |
| FlowMediaStreamFmtpColorimetryBt709 | BT709 |
| FlowMediaStreamFmtpColorimetryBt2020 | BT2020 |
| FlowMediaStreamFmtpColorimetryBt2100 | BT2100 |
| FlowMediaStreamFmtpColorimetrySt20651 | ST2065-1 |
| FlowMediaStreamFmtpColorimetrySt20653 | ST2065-3 |
| FlowMediaStreamFmtpColorimetryXyz | XYZ |
| Value |
|---|
BT601 |
BT709 |
BT2020 |
BT2100 |
ST2065-1 |
ST2065-3 |
XYZ |
| Name | Value |
|---|
| Bt601 | BT601 |
| Bt709 | BT709 |
| Bt2020 | BT2020 |
| Bt2100 | BT2100 |
| St20651 | ST2065-1 |
| St20653 | ST2065-3 |
| Xyz | XYZ |
| Name | Value |
|---|
| Bt601 | BT601 |
| Bt709 | BT709 |
| Bt2020 | BT2020 |
| Bt2100 | BT2100 |
| St20651 | ST2065-1 |
| St20653 | ST2065-3 |
| Xyz | XYZ |
| Name | Value |
|---|
| BT601 | BT601 |
| BT709 | BT709 |
| BT2020 | BT2020 |
| BT2100 | BT2100 |
| ST20651 | ST2065-1 |
| ST20653 | ST2065-3 |
| XYZ | XYZ |
| Value |
|---|
BT601 |
BT709 |
BT2020 |
BT2100 |
ST2065-1 |
ST2065-3 |
XYZ |
The encoding range of the video.
| Name | Value |
|---|
| Narrow | NARROW |
| Full | FULL |
| Fullprotect | FULLPROTECT |
| Name | Value |
|---|
| FlowMediaStreamFmtpRangeNarrow | NARROW |
| FlowMediaStreamFmtpRangeFull | FULL |
| FlowMediaStreamFmtpRangeFullprotect | FULLPROTECT |
| Value |
|---|
NARROW |
FULL |
FULLPROTECT |
| Name | Value |
|---|
| Narrow | NARROW |
| Full | FULL |
| Fullprotect | FULLPROTECT |
| Name | Value |
|---|
| Narrow | NARROW |
| Full | FULL |
| Fullprotect | FULLPROTECT |
| Name | Value |
|---|
| NARROW | NARROW |
| FULL | FULL |
| FULLPROTECT | FULLPROTECT |
| Value |
|---|
NARROW |
FULL |
FULLPROTECT |
The type of compression that was used to smooth the video's appearance.
| Name | Value |
|---|
| Progressive | progressive |
| Interlace | interlace |
| ProgressiveSegmentedFrame | progressive-segmented-frame |
| Name | Value |
|---|
| FlowMediaStreamFmtpScanModeProgressive | progressive |
| FlowMediaStreamFmtpScanModeInterlace | interlace |
| FlowMediaStreamFmtpScanModeProgressiveSegmentedFrame | progressive-segmented-frame |
| Value |
|---|
progressive |
interlace |
progressive-segmented-frame |
| Name | Value |
|---|
| Progressive | progressive |
| Interlace | interlace |
| ProgressiveSegmentedFrame | progressive-segmented-frame |
| Name | Value |
|---|
| Progressive | progressive |
| Interlace | interlace |
| ProgressiveSegmentedFrame | progressive-segmented-frame |
| Name | Value |
|---|
| PROGRESSIVE | progressive |
| INTERLACE | interlace |
| PROGRESSIVE_SEGMENTED_FRAME | progressive-segmented-frame |
| Value |
|---|
progressive |
interlace |
progressive-segmented-frame |
The transfer characteristic system (TCS) that is used in the video.
| Name | Value |
|---|
| Sdr | SDR |
| Pq | PQ |
| Hlg | HLG |
| Linear | LINEAR |
| Bt2100linpq | BT2100LINPQ |
| Bt2100linhlg | BT2100LINHLG |
| St20651 | ST2065-1 |
| St4281 | ST428-1 |
| Density | DENSITY |
| Name | Value |
|---|
| FlowMediaStreamFmtpTcsSdr | SDR |
| FlowMediaStreamFmtpTcsPq | PQ |
| FlowMediaStreamFmtpTcsHlg | HLG |
| FlowMediaStreamFmtpTcsLinear | LINEAR |
| FlowMediaStreamFmtpTcsBt2100linpq | BT2100LINPQ |
| FlowMediaStreamFmtpTcsBt2100linhlg | BT2100LINHLG |
| FlowMediaStreamFmtpTcsSt20651 | ST2065-1 |
| FlowMediaStreamFmtpTcsSt4281 | ST428-1 |
| FlowMediaStreamFmtpTcsDensity | DENSITY |
| Value |
|---|
SDR |
PQ |
HLG |
LINEAR |
BT2100LINPQ |
BT2100LINHLG |
ST2065-1 |
ST428-1 |
DENSITY |
| Name | Value |
|---|
| Sdr | SDR |
| Pq | PQ |
| Hlg | HLG |
| Linear | LINEAR |
| Bt2100linpq | BT2100LINPQ |
| Bt2100linhlg | BT2100LINHLG |
| St20651 | ST2065-1 |
| St4281 | ST428-1 |
| Density | DENSITY |
| Name | Value |
|---|
| Sdr | SDR |
| Pq | PQ |
| Hlg | HLG |
| Linear | LINEAR |
| Bt2100linpq | BT2100LINPQ |
| Bt2100linhlg | BT2100LINHLG |
| St20651 | ST2065-1 |
| St4281 | ST428-1 |
| Density | DENSITY |
| Name | Value |
|---|
| SDR | SDR |
| PQ | PQ |
| HLG | HLG |
| LINEAR | LINEAR |
| BT2100LINPQ | BT2100LINPQ |
| BT2100LINHLG | BT2100LINHLG |
| ST20651 | ST2065-1 |
| ST4281 | ST428-1 |
| DENSITY | DENSITY |
| Value |
|---|
SDR |
PQ |
HLG |
LINEAR |
BT2100LINPQ |
BT2100LINHLG |
ST2065-1 |
ST428-1 |
DENSITY |
Attributes that are related to the media stream.
- Fmtp
FlowMediaStreamFmtp
- Lang
string
- The audio language, in a format that is recognized by the receiver. Can only be specified for an audio media stream.
- fmtp
object
- lang
string
- The audio language, in a format that is recognized by the receiver. Can only be specified for an audio media stream.
- fmtp
FlowMediaStreamFmtp
- lang
String
- The audio language, in a format that is recognized by the receiver. Can only be specified for an audio media stream.
- fmtp
FlowMediaStreamFmtp
- lang
string
- The audio language, in a format that is recognized by the receiver. Can only be specified for an audio media stream.
- fmtp
FlowMediaStreamFmtp
- lang
str
- The audio language, in a format that is recognized by the receiver. Can only be specified for an audio media stream.
- fmtp
Property Map
- lang
String
- The audio language, in a format that is recognized by the receiver. Can only be specified for an audio media stream.
The type of media stream.
| Name | Value |
|---|
| Video | video |
| Audio | audio |
| AncillaryData | ancillary-data |
| Name | Value |
|---|
| FlowMediaStreamMediaStreamTypeVideo | video |
| FlowMediaStreamMediaStreamTypeAudio | audio |
| FlowMediaStreamMediaStreamTypeAncillaryData | ancillary-data |
| Value |
|---|
video |
audio |
ancillary-data |
| Name | Value |
|---|
| Video | video |
| Audio | audio |
| AncillaryData | ancillary-data |
| Name | Value |
|---|
| Video | video |
| Audio | audio |
| AncillaryData | ancillary-data |
| Name | Value |
|---|
| VIDEO | video |
| AUDIO | audio |
| ANCILLARY_DATA | ancillary-data |
| Value |
|---|
video |
audio |
ancillary-data |
Tag, TagArgs
A set of tags to apply to the resource.
- Key
string
- The key name of the tag
- Value
string
- The value of the tag
- Key
string
- The key name of the tag
- Value
string
- The value of the tag
- key
string
- The key name of the tag
- value
string
- The value of the tag
- key
String
- The key name of the tag
- value
String
- The value of the tag
- key
string
- The key name of the tag
- value
string
- The value of the tag
- key
str
- The key name of the tag
- value
str
- The value of the tag
- key
String
- The key name of the tag
- value
String
- The value of the tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0