CfnFlowProps

class aws_cdk.aws_mediaconnect.CfnFlowProps(*, name, source, availability_zone=None, source_failover_config=None)

Bases: object

Properties for defining a CfnFlow.

Parameters
  • name (str) – The name of the flow.

  • source (Union[SourceProperty, IResolvable]) – The settings for the source that you want to use for the new flow.

  • availability_zone (Optional[str]) – The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS Region.

  • source_failover_config (Union[IResolvable, FailoverConfigProperty, None]) – The settings for source failover.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_mediaconnect as mediaconnect

cfn_flow_props = mediaconnect.CfnFlowProps(
    name="name",
    source=mediaconnect.CfnFlow.SourceProperty(
        decryption=mediaconnect.CfnFlow.EncryptionProperty(
            role_arn="roleArn",

            # the properties below are optional
            algorithm="algorithm",
            constant_initialization_vector="constantInitializationVector",
            device_id="deviceId",
            key_type="keyType",
            region="region",
            resource_id="resourceId",
            secret_arn="secretArn",
            url="url"
        ),
        description="description",
        entitlement_arn="entitlementArn",
        ingest_ip="ingestIp",
        ingest_port=123,
        max_bitrate=123,
        max_latency=123,
        min_latency=123,
        name="name",
        protocol="protocol",
        source_arn="sourceArn",
        source_ingest_port="sourceIngestPort",
        stream_id="streamId",
        vpc_interface_name="vpcInterfaceName",
        whitelist_cidr="whitelistCidr"
    ),

    # the properties below are optional
    availability_zone="availabilityZone",
    source_failover_config=mediaconnect.CfnFlow.FailoverConfigProperty(
        recovery_window=123,
        state="state"
    )
)

Attributes

availability_zone

The Availability Zone that you want to create the flow in.

These options are limited to the Availability Zones within the current AWS Region.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-availabilityzone

Return type

Optional[str]

name

The name of the flow.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-name

Return type

str

source

The settings for the source that you want to use for the new flow.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-source

Return type

Union[SourceProperty, IResolvable]

source_failover_config

The settings for source failover.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-sourcefailoverconfig

Return type

Union[IResolvable, FailoverConfigProperty, None]