AWS Native

Pulumi Official
Package maintained by Pulumi
v0.19.0 published on Wednesday, Jun 8, 2022 by Pulumi

Flow

Resource schema for AWS::MediaConnect::Flow

Create a Flow Resource

new Flow(name: string, args: FlowArgs, opts?: CustomResourceOptions);
@overload
def Flow(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         availability_zone: Optional[str] = None,
         name: Optional[str] = None,
         source: Optional[FlowSourceArgs] = None,
         source_failover_config: Optional[FlowFailoverConfigArgs] = None)
@overload
def Flow(resource_name: str,
         args: FlowArgs,
         opts: Optional[ResourceOptions] = None)
func NewFlow(ctx *Context, name string, args FlowArgs, opts ...ResourceOption) (*Flow, error)
public Flow(string name, FlowArgs args, CustomResourceOptions? opts = null)
public Flow(String name, FlowArgs args)
public Flow(String name, FlowArgs args, CustomResourceOptions options)
type: aws-native:mediaconnect:Flow
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args FlowArgs
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 FlowArgs
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 FlowArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args FlowArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args FlowArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Flow 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 Flow resource accepts the following input properties:

Source Pulumi.AwsNative.MediaConnect.Inputs.FlowSourceArgs

The source of the flow.

AvailabilityZone string

The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.

Name string

The name of the flow.

SourceFailoverConfig Pulumi.AwsNative.MediaConnect.Inputs.FlowFailoverConfigArgs

The source failover config of the flow.

Source FlowSourceTypeArgs

The source of the flow.

AvailabilityZone string

The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.

Name string

The name of the flow.

SourceFailoverConfig FlowFailoverConfigArgs

The source failover config of the flow.

source FlowSourceArgs

The source of the flow.

availabilityZone String

The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.

name String

The name of the flow.

sourceFailoverConfig FlowFailoverConfigArgs

The source failover config of the flow.

source FlowSourceArgs

The source of the flow.

availabilityZone string

The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.

name string

The name of the flow.

sourceFailoverConfig FlowFailoverConfigArgs

The source failover config of the flow.

source FlowSourceArgs

The source of the flow.

availability_zone str

The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.

name str

The name of the flow.

source_failover_config FlowFailoverConfigArgs

The source failover config of the flow.

source Property Map

The source of the flow.

availabilityZone String

The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.

name String

The name of the flow.

sourceFailoverConfig Property Map

The source failover config of the flow.

Outputs

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

FlowArn string

The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.

FlowAvailabilityZone string

The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.(ReadOnly)

Id string

The provider-assigned unique ID for this managed resource.

FlowArn string

The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.

FlowAvailabilityZone string

The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.(ReadOnly)

Id string

The provider-assigned unique ID for this managed resource.

flowArn String

The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.

flowAvailabilityZone String

The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.(ReadOnly)

id String

The provider-assigned unique ID for this managed resource.

flowArn string

The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.

flowAvailabilityZone string

The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.(ReadOnly)

id string

The provider-assigned unique ID for this managed resource.

flow_arn str

The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.

flow_availability_zone str

The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.(ReadOnly)

id str

The provider-assigned unique ID for this managed resource.

flowArn String

The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.

flowAvailabilityZone String

The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.(ReadOnly)

id String

The provider-assigned unique ID for this managed resource.

Supporting Types

FlowEncryption

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.FlowEncryptionAlgorithm

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.FlowEncryptionKeyType

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 FlowEncryptionAlgorithm

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 FlowEncryptionKeyType

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 FlowEncryptionAlgorithm

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 FlowEncryptionKeyType

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 FlowEncryptionAlgorithm

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 FlowEncryptionKeyType

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 FlowEncryptionAlgorithm

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 FlowEncryptionKeyType

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.

FlowEncryptionAlgorithm

Aes128
aes128
Aes192
aes192
Aes256
aes256
FlowEncryptionAlgorithmAes128
aes128
FlowEncryptionAlgorithmAes192
aes192
FlowEncryptionAlgorithmAes256
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

FlowEncryptionKeyType

Speke
speke
StaticKey
static-key
SrtPassword
srt-password
FlowEncryptionKeyTypeSpeke
speke
FlowEncryptionKeyTypeStaticKey
static-key
FlowEncryptionKeyTypeSrtPassword
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

FlowFailoverConfig

RecoveryWindow int

Search window time to look for dash-7 packets

State Pulumi.AwsNative.MediaConnect.FlowFailoverConfigState
RecoveryWindow int

Search window time to look for dash-7 packets

State FlowFailoverConfigState
recoveryWindow Integer

Search window time to look for dash-7 packets

state FlowFailoverConfigState
recoveryWindow number

Search window time to look for dash-7 packets

state FlowFailoverConfigState
recovery_window int

Search window time to look for dash-7 packets

state FlowFailoverConfigState
recoveryWindow Number

Search window time to look for dash-7 packets

state "ENABLED" | "DISABLED"

FlowFailoverConfigState

Enabled
ENABLED
Disabled
DISABLED
FlowFailoverConfigStateEnabled
ENABLED
FlowFailoverConfigStateDisabled
DISABLED
Enabled
ENABLED
Disabled
DISABLED
Enabled
ENABLED
Disabled
DISABLED
ENABLED
ENABLED
DISABLED
DISABLED
"ENABLED"
ENABLED
"DISABLED"
DISABLED

FlowSource

Decryption Pulumi.AwsNative.MediaConnect.Inputs.FlowEncryption

The type of decryption that is used on the content ingested from this source.

Description string

A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.

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.

IngestIp string

The IP address that the flow will be listening on for incoming content.

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 or output.

SourceArn string

The ARN of the source.

SourceIngestPort string

The port that the flow will be listening on for incoming content.(ReadOnly)

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.

Decryption FlowEncryption

The type of decryption that is used on the content ingested from this source.

Description string

A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.

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.

IngestIp string

The IP address that the flow will be listening on for incoming content.

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 or output.

SourceArn string

The ARN of the source.

SourceIngestPort string

The port that the flow will be listening on for incoming content.(ReadOnly)

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.

decryption FlowEncryption

The type of decryption that is used on the content ingested from this source.

description String

A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.

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.

ingestIp String

The IP address that the flow will be listening on for incoming content.

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 or output.

sourceArn String

The ARN of the source.

sourceIngestPort String

The port that the flow will be listening on for incoming content.(ReadOnly)

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.

decryption FlowEncryption

The type of decryption that is used on the content ingested from this source.

description string

A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.

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.

ingestIp string

The IP address that the flow will be listening on for incoming content.

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 or output.

sourceArn string

The ARN of the source.

sourceIngestPort string

The port that the flow will be listening on for incoming content.(ReadOnly)

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.

decryption FlowEncryption

The type of decryption that is used on the content ingested from this source.

description str

A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.

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.

ingest_ip str

The IP address that the flow will be listening on for incoming content.

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 or output.

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)

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.

decryption Property Map

The type of decryption that is used on the content ingested from this source.

description String

A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.

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.

ingestIp String

The IP address that the flow will be listening on for incoming content.

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" | "srt-listener"

The protocol that is used by the source or output.

sourceArn String

The ARN of the source.

sourceIngestPort String

The port that the flow will be listening on for incoming content.(ReadOnly)

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.

FlowSourceProtocol

ZixiPush
zixi-push
RtpFec
rtp-fec
Rtp
rtp
Rist
rist
SrtListener
srt-listener
FlowSourceProtocolZixiPush
zixi-push
FlowSourceProtocolRtpFec
rtp-fec
FlowSourceProtocolRtp
rtp
FlowSourceProtocolRist
rist
FlowSourceProtocolSrtListener
srt-listener
ZixiPush
zixi-push
RtpFec
rtp-fec
Rtp
rtp
Rist
rist
SrtListener
srt-listener
ZixiPush
zixi-push
RtpFec
rtp-fec
Rtp
rtp
Rist
rist
SrtListener
srt-listener
ZIXI_PUSH
zixi-push
RTP_FEC
rtp-fec
RTP
rtp
RIST
rist
SRT_LISTENER
srt-listener
"zixi-push"
zixi-push
"rtp-fec"
rtp-fec
"rtp"
rtp
"rist"
rist
"srt-listener"
srt-listener

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0