AWS Native v0.64.0, Jun 2 23

aws-native.mediaconnect.FlowSource

Explore with Pulumi AI

Resource schema for AWS::MediaConnect::FlowSource

Create FlowSource Resource

new FlowSource(name: string, args: FlowSourceArgs, opts?: CustomResourceOptions);

@overload
def FlowSource(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               decryption: Optional[FlowSourceEncryptionArgs] = None,
               description: Optional[str] = None,
               entitlement_arn: Optional[str] = None,
               flow_arn: Optional[str] = None,
               ingest_port: Optional[int] = None,
               max_bitrate: Optional[int] = None,
               max_latency: Optional[int] = None,
               min_latency: Optional[int] = None,
               name: Optional[str] = None,
               protocol: Optional[FlowSourceProtocol] = None,
               sender_control_port: Optional[int] = None,
               sender_ip_address: Optional[str] = None,
               source_listener_address: Optional[str] = None,
               source_listener_port: Optional[int] = None,
               stream_id: Optional[str] = None,
               vpc_interface_name: Optional[str] = None,
               whitelist_cidr: Optional[str] = None)
@overload
def FlowSource(resource_name: str,
               args: FlowSourceInitArgs,
               opts: Optional[ResourceOptions] = None)

func NewFlowSource(ctx *Context, name string, args FlowSourceArgs, opts ...ResourceOption) (*FlowSource, error)

public FlowSource(string name, FlowSourceArgs args, CustomResourceOptions? opts = null)

public FlowSource(String name, FlowSourceArgs args)
public FlowSource(String name, FlowSourceArgs args, CustomResourceOptions options)

type: aws-native:mediaconnect:FlowSource
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args FlowSourceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args FlowSourceInitArgs: The arguments to resource properties.
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 resource.
args FlowSourceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args FlowSourceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args FlowSourceArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

FlowSource Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The FlowSource resource accepts the following input properties:

Description string: A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
Decryption Pulumi.AwsNative.MediaConnect.Inputs.FlowSourceEncryptionArgs: The type of encryption that is used on the content ingested from this source.
EntitlementArn string: The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
FlowArn string: The ARN of the flow.
IngestPort int: The port that the flow will be listening on for incoming content.
MaxBitrate int: The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
MaxLatency int: The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
MinLatency int: The minimum latency in milliseconds.
Name string: The name of the source.
Protocol Pulumi.AwsNative.MediaConnect.FlowSourceProtocol: The protocol that is used by the source.
SenderControlPort int: The port that the flow uses to send outbound requests to initiate connection with the sender for fujitsu-qos protocol.
SenderIpAddress string: The IP address that the flow communicates with to initiate connection with the sender for fujitsu-qos protocol.
SourceListenerAddress string: Source IP or domain name for SRT-caller protocol.
SourceListenerPort int: Source port for SRT-caller protocol.
StreamId string: The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
VpcInterfaceName string: The name of the VPC Interface this Source is configured with.
WhitelistCidr string: The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

Description string: A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
Decryption FlowSourceEncryptionArgs: The type of encryption that is used on the content ingested from this source.
EntitlementArn string: The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
FlowArn string: The ARN of the flow.
IngestPort int: The port that the flow will be listening on for incoming content.
MaxBitrate int: The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
MaxLatency int: The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
MinLatency int: The minimum latency in milliseconds.
Name string: The name of the source.
Protocol FlowSourceProtocol: The protocol that is used by the source.
SenderControlPort int: The port that the flow uses to send outbound requests to initiate connection with the sender for fujitsu-qos protocol.
SenderIpAddress string: The IP address that the flow communicates with to initiate connection with the sender for fujitsu-qos protocol.
SourceListenerAddress string: Source IP or domain name for SRT-caller protocol.
SourceListenerPort int: Source port for SRT-caller protocol.
StreamId string: The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
VpcInterfaceName string: The name of the VPC Interface this Source is configured with.
WhitelistCidr string: The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

description String: A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
decryption FlowSourceEncryptionArgs: The type of encryption that is used on the content ingested from this source.
entitlementArn String: The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
flowArn String: The ARN of the flow.
ingestPort Integer: The port that the flow will be listening on for incoming content.
maxBitrate Integer: The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
maxLatency Integer: The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
minLatency Integer: The minimum latency in milliseconds.
name String: The name of the source.
protocol FlowSourceProtocol: The protocol that is used by the source.
senderControlPort Integer: The port that the flow uses to send outbound requests to initiate connection with the sender for fujitsu-qos protocol.
senderIpAddress String: The IP address that the flow communicates with to initiate connection with the sender for fujitsu-qos protocol.
sourceListenerAddress String: Source IP or domain name for SRT-caller protocol.
sourceListenerPort Integer: Source port for SRT-caller protocol.
streamId String: The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
vpcInterfaceName String: The name of the VPC Interface this Source is configured with.
whitelistCidr String: The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

description string: A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
decryption FlowSourceEncryptionArgs: The type of encryption that is used on the content ingested from this source.
entitlementArn string: The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
flowArn string: The ARN of the flow.
ingestPort number: The port that the flow will be listening on for incoming content.
maxBitrate number: The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
maxLatency number: The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
minLatency number: The minimum latency in milliseconds.
name string: The name of the source.
protocol FlowSourceProtocol: The protocol that is used by the source.
senderControlPort number: The port that the flow uses to send outbound requests to initiate connection with the sender for fujitsu-qos protocol.
senderIpAddress string: The IP address that the flow communicates with to initiate connection with the sender for fujitsu-qos protocol.
sourceListenerAddress string: Source IP or domain name for SRT-caller protocol.
sourceListenerPort number: Source port for SRT-caller protocol.
streamId string: The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
vpcInterfaceName string: The name of the VPC Interface this Source is configured with.
whitelistCidr string: The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

description str: A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
decryption FlowSourceEncryptionArgs: The type of encryption that is used on the content ingested from this source.
entitlement_arn str: The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
flow_arn str: The ARN of the flow.
ingest_port int: The port that the flow will be listening on for incoming content.
max_bitrate int: The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
max_latency int: The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
min_latency int: The minimum latency in milliseconds.
name str: The name of the source.
protocol FlowSourceProtocol: The protocol that is used by the source.
sender_control_port int: The port that the flow uses to send outbound requests to initiate connection with the sender for fujitsu-qos protocol.
sender_ip_address str: The IP address that the flow communicates with to initiate connection with the sender for fujitsu-qos protocol.
source_listener_address str: Source IP or domain name for SRT-caller protocol.
source_listener_port int: Source port for SRT-caller protocol.
stream_id str: The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
vpc_interface_name str: The name of the VPC Interface this Source is configured with.
whitelist_cidr str: The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

description String: A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
decryption Property Map: The type of encryption that is used on the content ingested from this source.
entitlementArn String: The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
flowArn String: The ARN of the flow.
ingestPort Number: The port that the flow will be listening on for incoming content.
maxBitrate Number: The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
maxLatency Number: The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
minLatency Number: The minimum latency in milliseconds.
name String: The name of the source.
protocol "zixi-push" | "rtp-fec" | "rtp" | "rist" | "fujitsu-qos" | "srt-listener" | "srt-caller": The protocol that is used by the source.
senderControlPort Number: The port that the flow uses to send outbound requests to initiate connection with the sender for fujitsu-qos protocol.
senderIpAddress String: The IP address that the flow communicates with to initiate connection with the sender for fujitsu-qos protocol.
sourceListenerAddress String: Source IP or domain name for SRT-caller protocol.
sourceListenerPort Number: Source port for SRT-caller protocol.
streamId String: The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
vpcInterfaceName String: The name of the VPC Interface this Source is configured with.
whitelistCidr String: The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

Outputs

All input properties are implicitly available as output properties. Additionally, the FlowSource resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
IngestIp string: The IP address that the flow will be listening on for incoming content.
SourceArn string: The ARN of the source.
SourceIngestPort string: The port that the flow will be listening on for incoming content.(ReadOnly)

Id string: The provider-assigned unique ID for this managed resource.
IngestIp string: The IP address that the flow will be listening on for incoming content.
SourceArn string: The ARN of the source.
SourceIngestPort string: The port that the flow will be listening on for incoming content.(ReadOnly)

id String: The provider-assigned unique ID for this managed resource.
ingestIp String: The IP address that the flow will be listening on for incoming content.
sourceArn String: The ARN of the source.
sourceIngestPort String: The port that the flow will be listening on for incoming content.(ReadOnly)

id string: The provider-assigned unique ID for this managed resource.
ingestIp string: The IP address that the flow will be listening on for incoming content.
sourceArn string: The ARN of the source.
sourceIngestPort string: The port that the flow will be listening on for incoming content.(ReadOnly)

id str: The provider-assigned unique ID for this managed resource.
ingest_ip str: The IP address that the flow will be listening on for incoming content.
source_arn str: The ARN of the source.
source_ingest_port str: The port that the flow will be listening on for incoming content.(ReadOnly)

id String: The provider-assigned unique ID for this managed resource.
ingestIp String: The IP address that the flow will be listening on for incoming content.
sourceArn String: The ARN of the source.
sourceIngestPort String: The port that the flow will be listening on for incoming content.(ReadOnly)

Supporting Types

FlowSourceEncryption

RoleArn string: The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
Algorithm Pulumi.AwsNative.MediaConnect.FlowSourceEncryptionAlgorithm: The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector string: A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
DeviceId string: The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
KeyType Pulumi.AwsNative.MediaConnect.FlowSourceEncryptionKeyType: The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region string: The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
ResourceId string: An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
SecretArn string: The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
Url string: The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.

RoleArn string: The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
Algorithm FlowSourceEncryptionAlgorithm: The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
ConstantInitializationVector string: A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
DeviceId string: The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
KeyType FlowSourceEncryptionKeyType: The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
Region string: The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
ResourceId string: An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
SecretArn string: The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
Url string: The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.

roleArn String: The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
algorithm FlowSourceEncryptionAlgorithm: The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
constantInitializationVector String: A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
deviceId String: The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
keyType FlowSourceEncryptionKeyType: The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
region String: The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
resourceId String: An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
secretArn String: The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
url String: The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.

roleArn string: The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
algorithm FlowSourceEncryptionAlgorithm: The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
constantInitializationVector string: A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
deviceId string: The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
keyType FlowSourceEncryptionKeyType: The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
region string: The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
resourceId string: An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
secretArn string: The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
url string: The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.

role_arn str: The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
algorithm FlowSourceEncryptionAlgorithm: The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
constant_initialization_vector str: A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
device_id str: The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
key_type FlowSourceEncryptionKeyType: The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
region str: The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
resource_id str: An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
secret_arn str: The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
url str: The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.

roleArn String: The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
algorithm "aes128" | "aes192" | "aes256": The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
constantInitializationVector String: A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
deviceId String: The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
keyType "speke" | "static-key" | "srt-password": The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
region String: The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
resourceId String: An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
secretArn String: The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
url String: The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.

FlowSourceEncryptionAlgorithm

Aes128: aes128
Aes192: aes192
Aes256: aes256

FlowSourceEncryptionAlgorithmAes128: aes128
FlowSourceEncryptionAlgorithmAes192: aes192
FlowSourceEncryptionAlgorithmAes256: aes256

Aes128: aes128
Aes192: aes192
Aes256: aes256

Aes128: aes128
Aes192: aes192
Aes256: aes256

AES128: aes128
AES192: aes192
AES256: aes256

"aes128": aes128
"aes192": aes192
"aes256": aes256

FlowSourceEncryptionKeyType

Speke: speke
StaticKey: static-key
SrtPassword: srt-password

FlowSourceEncryptionKeyTypeSpeke: speke
FlowSourceEncryptionKeyTypeStaticKey: static-key
FlowSourceEncryptionKeyTypeSrtPassword: srt-password

Speke: speke
StaticKey: static-key
SrtPassword: srt-password

Speke: speke
StaticKey: static-key
SrtPassword: srt-password

SPEKE: speke
STATIC_KEY: static-key
SRT_PASSWORD: srt-password

"speke": speke
"static-key": static-key
"srt-password": srt-password

FlowSourceProtocol

ZixiPush: zixi-push
RtpFec: rtp-fec
Rtp: rtp
Rist: rist
FujitsuQos: fujitsu-qos
SrtListener: srt-listener
SrtCaller: srt-caller

FlowSourceProtocolZixiPush: zixi-push
FlowSourceProtocolRtpFec: rtp-fec
FlowSourceProtocolRtp: rtp
FlowSourceProtocolRist: rist
FlowSourceProtocolFujitsuQos: fujitsu-qos
FlowSourceProtocolSrtListener: srt-listener
FlowSourceProtocolSrtCaller: srt-caller

ZixiPush: zixi-push
RtpFec: rtp-fec
Rtp: rtp
Rist: rist
FujitsuQos: fujitsu-qos
SrtListener: srt-listener
SrtCaller: srt-caller

ZixiPush: zixi-push
RtpFec: rtp-fec
Rtp: rtp
Rist: rist
FujitsuQos: fujitsu-qos
SrtListener: srt-listener
SrtCaller: srt-caller

ZIXI_PUSH: zixi-push
RTP_FEC: rtp-fec
RTP: rtp
RIST: rist
FUJITSU_QOS: fujitsu-qos
SRT_LISTENER: srt-listener
SRT_CALLER: srt-caller

"zixi-push": zixi-push
"rtp-fec": rtp-fec
"rtp": rtp
"rist": rist
"fujitsu-qos": fujitsu-qos
"srt-listener": srt-listener
"srt-caller": srt-caller

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0