AWS Native

v0.29.0 published on Thursday, Sep 8, 2022 by Pulumi

getFlow

Resource schema for AWS::MediaConnect::Flow

Using getFlow

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getFlow(args: GetFlowArgs, opts?: InvokeOptions): Promise<GetFlowResult>
function getFlowOutput(args: GetFlowOutputArgs, opts?: InvokeOptions): Output<GetFlowResult>
def get_flow(flow_arn: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetFlowResult
def get_flow_output(flow_arn: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetFlowResult]
func LookupFlow(ctx *Context, args *LookupFlowArgs, opts ...InvokeOption) (*LookupFlowResult, error)
func LookupFlowOutput(ctx *Context, args *LookupFlowOutputArgs, opts ...InvokeOption) LookupFlowResultOutput

> Note: This function is named LookupFlow in the Go SDK.

public static class GetFlow 
{
    public static Task<GetFlowResult> InvokeAsync(GetFlowArgs args, InvokeOptions? opts = null)
    public static Output<GetFlowResult> Invoke(GetFlowInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetFlowResult> getFlow(GetFlowArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws-native:mediaconnect:getFlow
  Arguments:
    # Arguments dictionary

The following arguments are supported:

FlowArn string

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

FlowArn string

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

flowArn String

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

flowArn string

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

flow_arn str

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

flowArn String

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

getFlow Result

The following output properties are available:

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)

Source Pulumi.AwsNative.MediaConnect.Outputs.FlowSource

The source of the flow.

SourceFailoverConfig Pulumi.AwsNative.MediaConnect.Outputs.FlowFailoverConfig

The source failover config of the flow.

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)

Source FlowSourceType

The source of the flow.

SourceFailoverConfig FlowFailoverConfig

The source failover config of the flow.

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)

source FlowSource

The source of the flow.

sourceFailoverConfig FlowFailoverConfig

The source failover config of the flow.

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)

source FlowSource

The source of the flow.

sourceFailoverConfig FlowFailoverConfig

The source failover config of the flow.

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)

source FlowSource

The source of the flow.

source_failover_config FlowFailoverConfig

The source failover config of the flow.

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)

source Property Map

The source of the flow.

sourceFailoverConfig Property Map

The source failover config of the flow.

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

FlowEncryptionKeyType

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

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

Package Details

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