CfnBridge

class aws_cdk.aws_mediaconnect.CfnBridge(scope, id, *, name, placement_arn, sources, egress_gateway_bridge=None, ingress_gateway_bridge=None, outputs=None, source_failover_config=None)

Bases: CfnResource

The AWS::MediaConnect::Bridge resource defines a connection between your data center’s gateway instances and the cloud.

For each bridge, you specify the type of bridge, transport protocol to use, and details for any outputs and failover.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html
CloudformationResource:: AWS::MediaConnect::Bridge
ExampleMetadata:: fixture=_generated

Example:

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

cfn_bridge = mediaconnect.CfnBridge(self, "MyCfnBridge",
    name="name",
    placement_arn="placementArn",
    sources=[mediaconnect.CfnBridge.BridgeSourceProperty(
        flow_source=mediaconnect.CfnBridge.BridgeFlowSourceProperty(
            flow_arn="flowArn",
            name="name",

            # the properties below are optional
            flow_vpc_interface_attachment=mediaconnect.CfnBridge.VpcInterfaceAttachmentProperty(
                vpc_interface_name="vpcInterfaceName"
            )
        ),
        network_source=mediaconnect.CfnBridge.BridgeNetworkSourceProperty(
            multicast_ip="multicastIp",
            name="name",
            network_name="networkName",
            port=123,
            protocol="protocol"
        )
    )],

    # the properties below are optional
    egress_gateway_bridge=mediaconnect.CfnBridge.EgressGatewayBridgeProperty(
        max_bitrate=123
    ),
    ingress_gateway_bridge=mediaconnect.CfnBridge.IngressGatewayBridgeProperty(
        max_bitrate=123,
        max_outputs=123
    ),
    outputs=[mediaconnect.CfnBridge.BridgeOutputProperty(
        network_output=mediaconnect.CfnBridge.BridgeNetworkOutputProperty(
            ip_address="ipAddress",
            name="name",
            network_name="networkName",
            port=123,
            protocol="protocol",
            ttl=123
        )
    )],
    source_failover_config=mediaconnect.CfnBridge.FailoverConfigProperty(
        failover_mode="failoverMode",

        # the properties below are optional
        source_priority=mediaconnect.CfnBridge.SourcePriorityProperty(
            primary_source="primarySource"
        ),
        state="state"
    )
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
name (str) – The name of the bridge. This name can not be modified after the bridge is created.
placement_arn (str) – The bridge placement Amazon Resource Number (ARN).
sources (Union[IResolvable, Sequence[Union[IResolvable, BridgeSourceProperty, Dict[str, Any]]]]) – The sources that you want to add to this bridge.
egress_gateway_bridge (Union[IResolvable, EgressGatewayBridgeProperty, Dict[str, Any], None]) – Create a bridge with the egress bridge type. An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises.
ingress_gateway_bridge (Union[IResolvable, IngressGatewayBridgeProperty, Dict[str, Any], None]) – Create a bridge with the ingress bridge type. An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud.
outputs (Union[IResolvable, Sequence[Union[IResolvable, BridgeOutputProperty, Dict[str, Any]]], None]) – The outputs that you want to add to this bridge.
source_failover_config (Union[IResolvable, FailoverConfigProperty, Dict[str, Any], None]) – The settings for source failover.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::MediaConnect::Bridge'

attr_bridge_arn

The Amazon Resource Name (ARN) of the bridge.

CloudformationAttribute:: BridgeArn

attr_bridge_state

The current status of the bridge.

Possible values are: ACTIVE or STANDBY.

CloudformationAttribute:: BridgeState

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

egress_gateway_bridge: Create a bridge with the egress bridge type.

ingress_gateway_bridge: Create a bridge with the ingress bridge type.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name: The name of the bridge.

node: The tree node.

outputs: The outputs that you want to add to this bridge.

placement_arn: The bridge placement Amazon Resource Number (ARN).

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

source_failover_config: The settings for source failover.

sources: The sources that you want to add to this bridge.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

BridgeFlowSourceProperty

class CfnBridge.BridgeFlowSourceProperty(*, flow_arn, name, flow_vpc_interface_attachment=None)

Bases: object

The source of the bridge.

A flow source originates in MediaConnect as an existing cloud flow.

Parameters:

flow_arn (str) – The ARN of the cloud flow used as a source of this bridge.
name (str) – The name of the flow source.
flow_vpc_interface_attachment (Union[IResolvable, VpcInterfaceAttachmentProperty, Dict[str, Any], None]) – The name of the VPC interface attachment to use for this source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgeflowsource.html

ExampleMetadata:

fixture=_generated

Example:

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

bridge_flow_source_property = mediaconnect.CfnBridge.BridgeFlowSourceProperty(
    flow_arn="flowArn",
    name="name",

    # the properties below are optional
    flow_vpc_interface_attachment=mediaconnect.CfnBridge.VpcInterfaceAttachmentProperty(
        vpc_interface_name="vpcInterfaceName"
    )
)

Attributes

flow_arn

The ARN of the cloud flow used as a source of this bridge.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgeflowsource.html#cfn-mediaconnect-bridge-bridgeflowsource-flowarn

flow_vpc_interface_attachment

The name of the VPC interface attachment to use for this source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgeflowsource.html#cfn-mediaconnect-bridge-bridgeflowsource-flowvpcinterfaceattachment

name

The name of the flow source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgeflowsource.html#cfn-mediaconnect-bridge-bridgeflowsource-name

BridgeNetworkOutputProperty

class CfnBridge.BridgeNetworkOutputProperty(*, ip_address, name, network_name, port, protocol, ttl)

Bases: object

The output of the bridge.

A network output is delivered to your premises.

Parameters:

ip_address (str) – The network output IP Address.
name (str) – The network output name.
network_name (str) – The network output’s gateway network name.
port (Union[int, float]) – The network output port.
protocol (str) – The network output protocol.
ttl (Union[int, float]) – The network output TTL.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworkoutput.html

ExampleMetadata:

fixture=_generated

Example:

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

bridge_network_output_property = mediaconnect.CfnBridge.BridgeNetworkOutputProperty(
    ip_address="ipAddress",
    name="name",
    network_name="networkName",
    port=123,
    protocol="protocol",
    ttl=123
)

Attributes

ip_address

The network output IP Address.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworkoutput.html#cfn-mediaconnect-bridge-bridgenetworkoutput-ipaddress

name

The network output name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworkoutput.html#cfn-mediaconnect-bridge-bridgenetworkoutput-name

network_name

The network output’s gateway network name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworkoutput.html#cfn-mediaconnect-bridge-bridgenetworkoutput-networkname

port

The network output port.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworkoutput.html#cfn-mediaconnect-bridge-bridgenetworkoutput-port

protocol

The network output protocol.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworkoutput.html#cfn-mediaconnect-bridge-bridgenetworkoutput-protocol

ttl

The network output TTL.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworkoutput.html#cfn-mediaconnect-bridge-bridgenetworkoutput-ttl

BridgeNetworkSourceProperty

class CfnBridge.BridgeNetworkSourceProperty(*, multicast_ip, name, network_name, port, protocol)

Bases: object

The source of the bridge.

A network source originates at your premises.

Parameters:

multicast_ip (str) – The network source multicast IP.
name (str) – The name of the network source. This name is used to reference the source and must be unique among sources in this bridge.
network_name (str) – The network source’s gateway network name.
port (Union[int, float]) – The network source port.
protocol (str) – The network source protocol.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworksource.html

ExampleMetadata:

fixture=_generated

Example:

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

bridge_network_source_property = mediaconnect.CfnBridge.BridgeNetworkSourceProperty(
    multicast_ip="multicastIp",
    name="name",
    network_name="networkName",
    port=123,
    protocol="protocol"
)

Attributes

multicast_ip

The network source multicast IP.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworksource.html#cfn-mediaconnect-bridge-bridgenetworksource-multicastip

name

The name of the network source.

This name is used to reference the source and must be unique among sources in this bridge.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworksource.html#cfn-mediaconnect-bridge-bridgenetworksource-name

network_name

The network source’s gateway network name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworksource.html#cfn-mediaconnect-bridge-bridgenetworksource-networkname

port

The network source port.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworksource.html#cfn-mediaconnect-bridge-bridgenetworksource-port

protocol

The network source protocol.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworksource.html#cfn-mediaconnect-bridge-bridgenetworksource-protocol

BridgeOutputProperty

class CfnBridge.BridgeOutputProperty(*, network_output=None)

Bases: object

The output of the bridge.

Parameters:: network_output (Union[IResolvable, BridgeNetworkOutputProperty, Dict[str, Any], None]) – The output of the bridge. A network output is delivered to your premises.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgeoutput.html
ExampleMetadata:: fixture=_generated

Example:

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

bridge_output_property = mediaconnect.CfnBridge.BridgeOutputProperty(
    network_output=mediaconnect.CfnBridge.BridgeNetworkOutputProperty(
        ip_address="ipAddress",
        name="name",
        network_name="networkName",
        port=123,
        protocol="protocol",
        ttl=123
    )
)

Attributes

network_output

The output of the bridge.

A network output is delivered to your premises.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgeoutput.html#cfn-mediaconnect-bridge-bridgeoutput-networkoutput

BridgeSourceProperty

class CfnBridge.BridgeSourceProperty(*, flow_source=None, network_source=None)

Bases: object

The bridge’s source.

Parameters:

flow_source (Union[IResolvable, BridgeFlowSourceProperty, Dict[str, Any], None]) – The source of the bridge. A flow source originates in MediaConnect as an existing cloud flow.
network_source (Union[IResolvable, BridgeNetworkSourceProperty, Dict[str, Any], None]) – The source of the bridge. A network source originates at your premises.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgesource.html

ExampleMetadata:

fixture=_generated

Example:

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

bridge_source_property = mediaconnect.CfnBridge.BridgeSourceProperty(
    flow_source=mediaconnect.CfnBridge.BridgeFlowSourceProperty(
        flow_arn="flowArn",
        name="name",

        # the properties below are optional
        flow_vpc_interface_attachment=mediaconnect.CfnBridge.VpcInterfaceAttachmentProperty(
            vpc_interface_name="vpcInterfaceName"
        )
    ),
    network_source=mediaconnect.CfnBridge.BridgeNetworkSourceProperty(
        multicast_ip="multicastIp",
        name="name",
        network_name="networkName",
        port=123,
        protocol="protocol"
    )
)

Attributes

flow_source

The source of the bridge.

A flow source originates in MediaConnect as an existing cloud flow.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgesource.html#cfn-mediaconnect-bridge-bridgesource-flowsource

network_source

The source of the bridge.

A network source originates at your premises.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgesource.html#cfn-mediaconnect-bridge-bridgesource-networksource

EgressGatewayBridgeProperty

class CfnBridge.EgressGatewayBridgeProperty(*, max_bitrate)

Bases: object

Create a bridge with the egress bridge type.

An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises.

Parameters:: max_bitrate (Union[int, float]) – The maximum expected bitrate (in bps) of the egress bridge.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-egressgatewaybridge.html
ExampleMetadata:: fixture=_generated

Example:

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

egress_gateway_bridge_property = mediaconnect.CfnBridge.EgressGatewayBridgeProperty(
    max_bitrate=123
)

Attributes

max_bitrate

The maximum expected bitrate (in bps) of the egress bridge.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-egressgatewaybridge.html#cfn-mediaconnect-bridge-egressgatewaybridge-maxbitrate

FailoverConfigProperty

class CfnBridge.FailoverConfigProperty(*, failover_mode, source_priority=None, state=None)

Bases: object

The settings for source failover.

Parameters:

failover_mode (str) – The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams.
source_priority (Union[IResolvable, SourcePriorityProperty, Dict[str, Any], None]) – The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams. This setting only applies when Failover Mode is set to FAILOVER.
state (Optional[str]) – The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-failoverconfig.html

ExampleMetadata:

fixture=_generated

Example:

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

failover_config_property = mediaconnect.CfnBridge.FailoverConfigProperty(
    failover_mode="failoverMode",

    # the properties below are optional
    source_priority=mediaconnect.CfnBridge.SourcePriorityProperty(
        primary_source="primarySource"
    ),
    state="state"
)

Attributes

failover_mode

The type of failover you choose for this flow.

MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-failoverconfig.html#cfn-mediaconnect-bridge-failoverconfig-failovermode

source_priority

The priority you want to assign to a source.

You can have a primary stream and a backup stream or two equally prioritized streams. This setting only applies when Failover Mode is set to FAILOVER.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-failoverconfig.html#cfn-mediaconnect-bridge-failoverconfig-sourcepriority

state

The state of source failover on the flow.

If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-failoverconfig.html#cfn-mediaconnect-bridge-failoverconfig-state

IngressGatewayBridgeProperty

class CfnBridge.IngressGatewayBridgeProperty(*, max_bitrate, max_outputs)

Bases: object

Create a bridge with the ingress bridge type.

An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud.

Parameters:

max_bitrate (Union[int, float]) – The maximum expected bitrate (in bps) of the ingress bridge.
max_outputs (Union[int, float]) – The maximum number of outputs on the ingress bridge.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-ingressgatewaybridge.html

ExampleMetadata:

fixture=_generated

Example:

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

ingress_gateway_bridge_property = mediaconnect.CfnBridge.IngressGatewayBridgeProperty(
    max_bitrate=123,
    max_outputs=123
)

Attributes

max_bitrate

The maximum expected bitrate (in bps) of the ingress bridge.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-ingressgatewaybridge.html#cfn-mediaconnect-bridge-ingressgatewaybridge-maxbitrate

max_outputs

The maximum number of outputs on the ingress bridge.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-ingressgatewaybridge.html#cfn-mediaconnect-bridge-ingressgatewaybridge-maxoutputs

SourcePriorityProperty

class CfnBridge.SourcePriorityProperty(*, primary_source=None)

Bases: object

The priority you want to assign to a source.

You can have a primary stream and a backup stream or two equally prioritized streams. This setting only applies when Failover Mode is set to FAILOVER.

Parameters:: primary_source (Optional[str]) – The name of the source you choose as the primary source for this flow.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-sourcepriority.html
ExampleMetadata:: fixture=_generated

Example:

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

source_priority_property = mediaconnect.CfnBridge.SourcePriorityProperty(
    primary_source="primarySource"
)

Attributes

primary_source

The name of the source you choose as the primary source for this flow.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-sourcepriority.html#cfn-mediaconnect-bridge-sourcepriority-primarysource

VpcInterfaceAttachmentProperty

class CfnBridge.VpcInterfaceAttachmentProperty(*, vpc_interface_name=None)

Bases: object

The VPC interface that you want to send your output to.

Parameters:: vpc_interface_name (Optional[str]) – The name of the VPC interface that you want to send your output to.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-vpcinterfaceattachment.html
ExampleMetadata:: fixture=_generated

Example:

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

vpc_interface_attachment_property = mediaconnect.CfnBridge.VpcInterfaceAttachmentProperty(
    vpc_interface_name="vpcInterfaceName"
)

Attributes

vpc_interface_name

The name of the VPC interface that you want to send your output to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-vpcinterfaceattachment.html#cfn-mediaconnect-bridge-vpcinterfaceattachment-vpcinterfacename