Package software.amazon.awscdk.services.mediaconnect

Class CfnBridge

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.mediaconnect.CfnBridge
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-12-06T14:43:21.739Z") @Stability(Stable) public class CfnBridge extends CfnResource implements IInspectable
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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.mediaconnect.*;
 CfnBridge cfnBridge = CfnBridge.Builder.create(this, "MyCfnBridge")
         .name("name")
         .placementArn("placementArn")
         .sources(List.of(BridgeSourceProperty.builder()
                 .flowSource(BridgeFlowSourceProperty.builder()
                         .flowArn("flowArn")
                         .name("name")
                         // the properties below are optional
                         .flowVpcInterfaceAttachment(VpcInterfaceAttachmentProperty.builder()
                                 .vpcInterfaceName("vpcInterfaceName")
                                 .build())
                         .build())
                 .networkSource(BridgeNetworkSourceProperty.builder()
                         .multicastIp("multicastIp")
                         .name("name")
                         .networkName("networkName")
                         .port(123)
                         .protocol("protocol")
                         .build())
                 .build()))
         // the properties below are optional
         .egressGatewayBridge(EgressGatewayBridgeProperty.builder()
                 .maxBitrate(123)
                 .build())
         .ingressGatewayBridge(IngressGatewayBridgeProperty.builder()
                 .maxBitrate(123)
                 .maxOutputs(123)
                 .build())
         .outputs(List.of(BridgeOutputProperty.builder()
                 .networkOutput(BridgeNetworkOutputProperty.builder()
                         .ipAddress("ipAddress")
                         .name("name")
                         .networkName("networkName")
                         .port(123)
                         .protocol("protocol")
                         .ttl(123)
                         .build())
                 .build()))
         .sourceFailoverConfig(FailoverConfigProperty.builder()
                 .failoverMode("failoverMode")
                 // the properties below are optional
                 .sourcePriority(SourcePriorityProperty.builder()
                         .primarySource("primarySource")
                         .build())
                 .state("state")
                 .build())
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnBridge

      protected CfnBridge(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnBridge

      protected CfnBridge(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnBridge

      @Stability(Stable) public CfnBridge(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnBridgeProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrBridgeArn

      @Stability(Stable) @NotNull public String getAttrBridgeArn()
      The Amazon Resource Name (ARN) of the bridge.

    • getAttrBridgeState

      @Stability(Stable) @NotNull public String getAttrBridgeState()
      The current status of the bridge.

      Possible values are: ACTIVE or STANDBY.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the bridge.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the bridge.

    • getPlacementArn

      @Stability(Stable) @NotNull public String getPlacementArn()
      The bridge placement Amazon Resource Number (ARN).

    • setPlacementArn

      @Stability(Stable) public void setPlacementArn(@NotNull String value)
      The bridge placement Amazon Resource Number (ARN).

    • getSources

      @Stability(Stable) @NotNull public Object getSources()
      The sources that you want to add to this bridge.

    • setSources

      @Stability(Stable) public void setSources(@NotNull IResolvable value)
      The sources that you want to add to this bridge.

    • setSources

      @Stability(Stable) public void setSources(@NotNull List<Object> value)
      The sources that you want to add to this bridge.

    • getEgressGatewayBridge

      @Stability(Stable) @Nullable public Object getEgressGatewayBridge()
      Create a bridge with the egress bridge type.

    • setEgressGatewayBridge

      @Stability(Stable) public void setEgressGatewayBridge(@Nullable IResolvable value)
      Create a bridge with the egress bridge type.

    • setEgressGatewayBridge

      @Stability(Stable) public void setEgressGatewayBridge(@Nullable CfnBridge.EgressGatewayBridgeProperty value)
      Create a bridge with the egress bridge type.

    • getIngressGatewayBridge

      @Stability(Stable) @Nullable public Object getIngressGatewayBridge()
      Create a bridge with the ingress bridge type.

    • setIngressGatewayBridge

      @Stability(Stable) public void setIngressGatewayBridge(@Nullable IResolvable value)
      Create a bridge with the ingress bridge type.

    • setIngressGatewayBridge

      @Stability(Stable) public void setIngressGatewayBridge(@Nullable CfnBridge.IngressGatewayBridgeProperty value)
      Create a bridge with the ingress bridge type.

    • getOutputs

      @Stability(Stable) @Nullable public Object getOutputs()
      The outputs that you want to add to this bridge.

    • setOutputs

      @Stability(Stable) public void setOutputs(@Nullable IResolvable value)
      The outputs that you want to add to this bridge.

    • setOutputs

      @Stability(Stable) public void setOutputs(@Nullable List<Object> value)
      The outputs that you want to add to this bridge.

    • getSourceFailoverConfig

      @Stability(Stable) @Nullable public Object getSourceFailoverConfig()
      The settings for source failover.

    • setSourceFailoverConfig

      @Stability(Stable) public void setSourceFailoverConfig(@Nullable IResolvable value)
      The settings for source failover.

    • setSourceFailoverConfig

      @Stability(Stable) public void setSourceFailoverConfig(@Nullable CfnBridge.FailoverConfigProperty value)
      The settings for source failover.