UNPKG

aws-cdk-lib

Version:

Version 2 of the AWS Cloud Development Kit library

1,075 lines 131 kB
import * as cdk from "../../core"; import * as constructs from "constructs"; import * as cfn_parse from "../../core/lib/helpers-internal"; /** * 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. * * @cloudformationResource AWS::MediaConnect::Bridge * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html */ export declare class CfnBridge extends cdk.CfnResource implements cdk.IInspectable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnBridge from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnBridge; /** * The Amazon Resource Name (ARN) of the bridge. * * @cloudformationAttribute BridgeArn */ readonly attrBridgeArn: string; /** * The current status of the bridge. Possible values are: ACTIVE or STANDBY. * * @cloudformationAttribute BridgeState */ readonly attrBridgeState: string; /** * Create a bridge with the egress bridge type. */ egressGatewayBridge?: CfnBridge.EgressGatewayBridgeProperty | cdk.IResolvable; /** * Create a bridge with the ingress bridge type. */ ingressGatewayBridge?: CfnBridge.IngressGatewayBridgeProperty | cdk.IResolvable; /** * The name of the bridge. */ name: string; /** * The outputs that you want to add to this bridge. */ outputs?: Array<CfnBridge.BridgeOutputProperty | cdk.IResolvable> | cdk.IResolvable; /** * The bridge placement Amazon Resource Number (ARN). */ placementArn: string; /** * The settings for source failover. */ sourceFailoverConfig?: CfnBridge.FailoverConfigProperty | cdk.IResolvable; /** * The sources that you want to add to this bridge. */ sources: Array<CfnBridge.BridgeSourceProperty | cdk.IResolvable> | cdk.IResolvable; /** * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnBridgeProps); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnBridge { /** * The settings for source failover. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-failoverconfig.html */ interface FailoverConfigProperty { /** * 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 */ readonly failoverMode: string; /** * 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 */ readonly sourcePriority?: cdk.IResolvable | CfnBridge.SourcePriorityProperty; /** * 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 */ readonly state?: string; } /** * 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. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-sourcepriority.html */ interface SourcePriorityProperty { /** * 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 */ readonly primarySource?: string; } /** * 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. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-ingressgatewaybridge.html */ interface IngressGatewayBridgeProperty { /** * 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 */ readonly maxBitrate: number; /** * 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 */ readonly maxOutputs: number; } /** * 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. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-egressgatewaybridge.html */ interface EgressGatewayBridgeProperty { /** * 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 */ readonly maxBitrate: number; } /** * The output of the bridge. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgeoutput.html */ interface BridgeOutputProperty { /** * 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 */ readonly networkOutput?: CfnBridge.BridgeNetworkOutputProperty | cdk.IResolvable; } /** * The output of the bridge. * * A network output is delivered to your premises. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworkoutput.html */ interface BridgeNetworkOutputProperty { /** * 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 */ readonly ipAddress: string; /** * The network output name. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworkoutput.html#cfn-mediaconnect-bridge-bridgenetworkoutput-name */ readonly name: string; /** * 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 */ readonly networkName: string; /** * The network output port. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworkoutput.html#cfn-mediaconnect-bridge-bridgenetworkoutput-port */ readonly port: number; /** * The network output protocol. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworkoutput.html#cfn-mediaconnect-bridge-bridgenetworkoutput-protocol */ readonly protocol: string; /** * The network output TTL. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworkoutput.html#cfn-mediaconnect-bridge-bridgenetworkoutput-ttl */ readonly ttl: number; } /** * The bridge's source. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgesource.html */ interface BridgeSourceProperty { /** * 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 */ readonly flowSource?: CfnBridge.BridgeFlowSourceProperty | cdk.IResolvable; /** * 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 */ readonly networkSource?: CfnBridge.BridgeNetworkSourceProperty | cdk.IResolvable; } /** * The source of the bridge. * * A network source originates at your premises. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworksource.html */ interface BridgeNetworkSourceProperty { /** * 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 */ readonly multicastIp: string; /** * 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 */ readonly name: string; /** * 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 */ readonly networkName: string; /** * The network source port. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworksource.html#cfn-mediaconnect-bridge-bridgenetworksource-port */ readonly port: number; /** * The network source protocol. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgenetworksource.html#cfn-mediaconnect-bridge-bridgenetworksource-protocol */ readonly protocol: string; } /** * The source of the bridge. * * A flow source originates in MediaConnect as an existing cloud flow. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-bridgeflowsource.html */ interface BridgeFlowSourceProperty { /** * 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 */ readonly flowArn: string; /** * 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 */ readonly flowVpcInterfaceAttachment?: cdk.IResolvable | CfnBridge.VpcInterfaceAttachmentProperty; /** * 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 */ readonly name: string; } /** * The VPC interface that you want to send your output to. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridge-vpcinterfaceattachment.html */ interface VpcInterfaceAttachmentProperty { /** * 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 */ readonly vpcInterfaceName?: string; } } /** * Properties for defining a `CfnBridge` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html */ export interface CfnBridgeProps { /** * 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html#cfn-mediaconnect-bridge-egressgatewaybridge */ readonly egressGatewayBridge?: CfnBridge.EgressGatewayBridgeProperty | cdk.IResolvable; /** * 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html#cfn-mediaconnect-bridge-ingressgatewaybridge */ readonly ingressGatewayBridge?: CfnBridge.IngressGatewayBridgeProperty | cdk.IResolvable; /** * The name of the bridge. * * This name can not be modified after the bridge is created. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html#cfn-mediaconnect-bridge-name */ readonly name: string; /** * The outputs that you want to add to this bridge. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html#cfn-mediaconnect-bridge-outputs */ readonly outputs?: Array<CfnBridge.BridgeOutputProperty | cdk.IResolvable> | cdk.IResolvable; /** * The bridge placement Amazon Resource Number (ARN). * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html#cfn-mediaconnect-bridge-placementarn */ readonly placementArn: string; /** * The settings for source failover. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html#cfn-mediaconnect-bridge-sourcefailoverconfig */ readonly sourceFailoverConfig?: CfnBridge.FailoverConfigProperty | cdk.IResolvable; /** * The sources that you want to add to this bridge. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridge.html#cfn-mediaconnect-bridge-sources */ readonly sources: Array<CfnBridge.BridgeSourceProperty | cdk.IResolvable> | cdk.IResolvable; } /** * Adds outputs to an existing bridge. * * @cloudformationResource AWS::MediaConnect::BridgeOutput * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridgeoutput.html */ export declare class CfnBridgeOutput extends cdk.CfnResource implements cdk.IInspectable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnBridgeOutput from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnBridgeOutput; /** * The ARN of the bridge that you want to describe. */ bridgeArn: string; /** * The network output name. */ name: string; /** * Add a network output to an existing bridge. */ networkOutput: CfnBridgeOutput.BridgeNetworkOutputProperty | cdk.IResolvable; /** * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnBridgeOutputProps); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnBridgeOutput { /** * The output of the bridge. * * A network output is delivered to your premises. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridgeoutput-bridgenetworkoutput.html */ interface BridgeNetworkOutputProperty { /** * The network output IP Address. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridgeoutput-bridgenetworkoutput.html#cfn-mediaconnect-bridgeoutput-bridgenetworkoutput-ipaddress */ readonly ipAddress: string; /** * The network output's gateway network name. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridgeoutput-bridgenetworkoutput.html#cfn-mediaconnect-bridgeoutput-bridgenetworkoutput-networkname */ readonly networkName: string; /** * The network output port. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridgeoutput-bridgenetworkoutput.html#cfn-mediaconnect-bridgeoutput-bridgenetworkoutput-port */ readonly port: number; /** * The network output protocol. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridgeoutput-bridgenetworkoutput.html#cfn-mediaconnect-bridgeoutput-bridgenetworkoutput-protocol */ readonly protocol: string; /** * The network output TTL. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridgeoutput-bridgenetworkoutput.html#cfn-mediaconnect-bridgeoutput-bridgenetworkoutput-ttl */ readonly ttl: number; } } /** * Properties for defining a `CfnBridgeOutput` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridgeoutput.html */ export interface CfnBridgeOutputProps { /** * The ARN of the bridge that you want to describe. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridgeoutput.html#cfn-mediaconnect-bridgeoutput-bridgearn */ readonly bridgeArn: string; /** * The network output name. * * This name is used to reference the output and must be unique among outputs in this bridge. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridgeoutput.html#cfn-mediaconnect-bridgeoutput-name */ readonly name: string; /** * Add a network output to an existing bridge. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridgeoutput.html#cfn-mediaconnect-bridgeoutput-networkoutput */ readonly networkOutput: CfnBridgeOutput.BridgeNetworkOutputProperty | cdk.IResolvable; } /** * Adds sources to an existing bridge. * * @cloudformationResource AWS::MediaConnect::BridgeSource * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridgesource.html */ export declare class CfnBridgeSource extends cdk.CfnResource implements cdk.IInspectable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnBridgeSource from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnBridgeSource; /** * The ARN of the bridge that you want to describe. */ bridgeArn: string; /** * Add a flow source to an existing bridge. */ flowSource?: CfnBridgeSource.BridgeFlowSourceProperty | cdk.IResolvable; /** * The name of the flow source. */ name: string; /** * Add a network source to an existing bridge. */ networkSource?: CfnBridgeSource.BridgeNetworkSourceProperty | cdk.IResolvable; /** * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnBridgeSourceProps); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnBridgeSource { /** * The source of the bridge. * * A network source originates at your premises. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridgesource-bridgenetworksource.html */ interface BridgeNetworkSourceProperty { /** * The network source multicast IP. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridgesource-bridgenetworksource.html#cfn-mediaconnect-bridgesource-bridgenetworksource-multicastip */ readonly multicastIp: string; /** * The network source's gateway network name. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridgesource-bridgenetworksource.html#cfn-mediaconnect-bridgesource-bridgenetworksource-networkname */ readonly networkName: string; /** * The network source port. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridgesource-bridgenetworksource.html#cfn-mediaconnect-bridgesource-bridgenetworksource-port */ readonly port: number; /** * The network source protocol. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridgesource-bridgenetworksource.html#cfn-mediaconnect-bridgesource-bridgenetworksource-protocol */ readonly protocol: string; } /** * The source of the bridge. * * A flow source originates in MediaConnect as an existing cloud flow. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridgesource-bridgeflowsource.html */ interface BridgeFlowSourceProperty { /** * 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-bridgesource-bridgeflowsource.html#cfn-mediaconnect-bridgesource-bridgeflowsource-flowarn */ readonly flowArn: string; /** * The name of the VPC interface attachment to use for this source. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridgesource-bridgeflowsource.html#cfn-mediaconnect-bridgesource-bridgeflowsource-flowvpcinterfaceattachment */ readonly flowVpcInterfaceAttachment?: cdk.IResolvable | CfnBridgeSource.VpcInterfaceAttachmentProperty; } /** * The VPC interface that you want to send your output to. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-bridgesource-vpcinterfaceattachment.html */ interface VpcInterfaceAttachmentProperty { /** * 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-bridgesource-vpcinterfaceattachment.html#cfn-mediaconnect-bridgesource-vpcinterfaceattachment-vpcinterfacename */ readonly vpcInterfaceName?: string; } } /** * Properties for defining a `CfnBridgeSource` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridgesource.html */ export interface CfnBridgeSourceProps { /** * The ARN of the bridge that you want to describe. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridgesource.html#cfn-mediaconnect-bridgesource-bridgearn */ readonly bridgeArn: string; /** * Add a flow source to an existing bridge. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridgesource.html#cfn-mediaconnect-bridgesource-flowsource */ readonly flowSource?: CfnBridgeSource.BridgeFlowSourceProperty | cdk.IResolvable; /** * The name of the flow 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-resource-mediaconnect-bridgesource.html#cfn-mediaconnect-bridgesource-name */ readonly name: string; /** * Add a network source to an existing bridge. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-bridgesource.html#cfn-mediaconnect-bridgesource-networksource */ readonly networkSource?: CfnBridgeSource.BridgeNetworkSourceProperty | cdk.IResolvable; } /** * The AWS::MediaConnect::Flow resource defines a connection between one or more video sources and one or more outputs. * * For each flow, you specify the transport protocol to use, encryption information, and details for any outputs or entitlements that you want. AWS Elemental MediaConnect returns an ingest endpoint where you can send your live video as a single unicast stream. The service replicates and distributes the video to every output that you specify, whether inside or outside the AWS Cloud. You can also set up entitlements on a flow to allow other AWS accounts to access your content. * * @cloudformationResource AWS::MediaConnect::Flow * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html */ export declare class CfnFlow extends cdk.CfnResource implements cdk.IInspectable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnFlow from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnFlow; /** * The outgoing IP address that MediaConnect uses to send video from the flow. * * @cloudformationAttribute EgressIp */ readonly attrEgressIp: string; /** * The Amazon Resource Name (ARN) of the flow. * * @cloudformationAttribute FlowArn */ readonly attrFlowArn: string; /** * The Availability Zone that the flow was created in. These options are limited to the Availability Zones within the current AWS Region. * * @cloudformationAttribute FlowAvailabilityZone */ readonly attrFlowAvailabilityZone: string; /** * The IP address that the flow listens on for incoming content. * * @cloudformationAttribute Source.IngestIp */ readonly attrSourceIngestIp: string; /** * The ARN of the source. * * @cloudformationAttribute Source.SourceArn */ readonly attrSourceSourceArn: string; /** * The port that the flow listens on for incoming content. If the protocol of the source is Zixi, the port must be set to 2088. * * @cloudformationAttribute Source.SourceIngestPort */ readonly attrSourceSourceIngestPort: string; /** * The Availability Zone that you want to create the flow in. */ availabilityZone?: string; /** * The maintenance settings you want to use for the flow. */ maintenance?: cdk.IResolvable | CfnFlow.MaintenanceProperty; /** * The media streams associated with the flow. */ mediaStreams?: Array<cdk.IResolvable | CfnFlow.MediaStreamProperty> | cdk.IResolvable; /** * The name of the flow. */ name: string; /** * The settings for the source that you want to use for the new flow. */ source: cdk.IResolvable | CfnFlow.SourceProperty; /** * The settings for source failover. */ sourceFailoverConfig?: CfnFlow.FailoverConfigProperty | cdk.IResolvable; /** * The settings for source monitoring. */ sourceMonitoringConfig?: cdk.IResolvable | CfnFlow.SourceMonitoringConfigProperty; /** * The VPC interfaces that you added to this flow. */ vpcInterfaces?: Array<cdk.IResolvable | CfnFlow.VpcInterfaceProperty> | cdk.IResolvable; /** * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnFlowProps); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnFlow { /** * The settings for source failover. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-failoverconfig.html */ interface FailoverConfigProperty { /** * 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. The string for this property must be entered as MERGE or FAILOVER. No other string entry is valid. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-failoverconfig.html#cfn-mediaconnect-flow-failoverconfig-failovermode */ readonly failoverMode?: string; /** * The size of the buffer (delay) that the service maintains. * * A larger buffer means a longer delay in transmitting the stream, but more room for error correction. A smaller buffer means a shorter delay, but less room for error correction. You can choose a value from 100-500 ms. If you keep this field blank, the service uses the default value of 200 ms. This setting only applies when Failover Mode is set to MERGE. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-failoverconfig.html#cfn-mediaconnect-flow-failoverconfig-recoverywindow */ readonly recoveryWindow?: number; /** * 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-flow-failoverconfig.html#cfn-mediaconnect-flow-failoverconfig-sourcepriority */ readonly sourcePriority?: cdk.IResolvable | CfnFlow.SourcePriorityProperty; /** * 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-flow-failoverconfig.html#cfn-mediaconnect-flow-failoverconfig-state */ readonly state?: string; } /** * 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. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-sourcepriority.html */ interface SourcePriorityProperty { /** * 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-flow-sourcepriority.html#cfn-mediaconnect-flow-sourcepriority-primarysource */ readonly primarySource: string; } /** * The details of the sources of the flow. * * If you are creating a flow with a VPC source, you must first create the flow with a temporary standard source by doing the following: * * - Use CloudFormation to create a flow with a standard source that uses the flow’s public IP address. * - Use CloudFormation to create the VPC interface to add to this flow. This can also be done as part of the previous step. * - After CloudFormation has created the flow and the VPC interface, update the source to point to the VPC interface that you created. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html */ interface SourceProperty { /** * The type of encryption that is used on the content ingested from the source. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-decryption */ readonly decryption?: CfnFlow.EncryptionProperty | cdk.IResolvable; /** * A description of the source. * * This description is not visible outside of the current AWS account. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-description */ readonly description?: 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-entitlementarn */ readonly entitlementArn?: string; /** * The source configuration for cloud flows receiving a stream from a bridge. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-gatewaybridgesource */ readonly gatewayBridgeSource?: CfnFlow.GatewayBridgeSourceProperty | cdk.IResolvable; /** * The IP address that the flow listens on for incoming content. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-ingestip */ readonly ingestIp?: string; /** * The port that the flow listens on for incoming content. * * If the protocol of the source is Zixi, the port must be set to 2088. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-ingestport */ readonly ingestPort?: number; /** * The maximum bitrate for RIST, RTP, and RTP-FEC streams. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-maxbitrate */ readonly maxBitrate?: number; /** * The maximum latency in milliseconds for a RIST or Zixi-based source. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-maxlatency */ readonly maxLatency?: number; /** * The size of the buffer (in milliseconds) to use to sync incoming source data. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-maxsyncbuffer */ readonly maxSyncBuffer?: number; /** * The media stream that is associated with the source, and the parameters for that association. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-mediastreamsourceconfigurations */ readonly mediaStreamSourceConfigurations?: Array<cdk.IResolvable | CfnFlow.MediaStreamSourceConfigurationProperty> | cdk.IResolvable; /** * The minimum latency in milliseconds for SRT-based streams. * * In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-minlatency */ readonly minLatency?: number; /** * The name of the source. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-name */ readonly name?: string; /** * The protocol that is used by the source. * * AWS CloudFormation does not currently support CDI or ST 2110 JPEG XS source protocols. * * > AWS Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-protocol */ readonly protocol?: string; /** * The port that the flow uses to send outbound requests to initiate connection with the sender. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-sendercontrolport */ readonly senderControlPort?: number; /** * The IP address that the flow communicates with to initiate connection with the sender. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-senderipaddress */ readonly senderIpAddress?: string; /** * The ARN of the source. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-sourcearn */ readonly sourceArn?: string; /** * The port that the flow listens on for incoming content. * * If the protocol of the source is Zixi, the port must be set to 2088. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-sourceingestport */ readonly sourceIngestPort?: string; /** * Source IP or domain name for SRT-caller protocol. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-sourcelisteneraddress */ readonly sourceListenerAddress?: string; /** * Source port for SRT-caller protocol. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-sourcelistenerport */ readonly sourceListenerPort?: number; /** * The stream ID that you want to use for the transport. * * This parameter applies only to Zixi-based streams. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-streamid */ readonly streamId?: string; /** * The name of the VPC interface that the source content comes from. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-vpcinterfacename */ readonly vpcInterfaceName?: string; /** * The range of IP addresses that are allowed to contribute content to your source. * * Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-source.html#cfn-mediaconnect-flow-source-whitelistcidr */ readonly whitelistCidr?: string; } /** * Information about the encryption of the flow. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-encryption.html */ interface EncryptionProperty { /** * The type of algorithm that is used for static key encryption (such as aes128, aes192, or aes256). * * If you are using SPEKE or SRT-password encryption, this property must be left blank. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-encryption.html#cfn-mediaconnect-flow-encryption-algorithm */ readonly algorithm?: 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-encryption.html#cfn-mediaconnect-flow-encryption-constantinitializationvector */ readonly constantInitializationVector?: 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-encryption.html#cfn-mediaconnect-flow-encryption-deviceid */ readonly deviceId?: string; /** * The type of key that is used for the encryption. * * If you don't specify a `keyType` value, the service uses the default setting ( `static-key` ). Valid key types are: `static-key` , `speke` , and `srt-password` . * * @default - "static-key" * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-encryption.html#cfn-mediaconnect-flow-encryption-keytype */ readonly keyType?: 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-encryption.html#cfn-mediaconnect-flow-encryption-region */ readonly region?: string; /** * An identifier for the content. * * The service sends this value to the key server to identify the current endpoint. The resource ID i