CfnFlowOutput

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.mediaconnect.CfnFlowOutput

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:48.839Z")
public class CfnFlowOutput
extends CfnResource
implements IInspectable

A CloudFormation `AWS::MediaConnect::FlowOutput`.

The AWS::MediaConnect::FlowOutput resource defines the destination address, protocol, and port that AWS Elemental MediaConnect sends the ingested video to. Each flow can have up to 50 outputs. An output can have the same protocol or a different protocol from the source. The following protocols are supported: RIST, RTP, RTP-FEC, SRT-listener, SRT-caller, Zixi pull, Zixi push, and Fujitsu-QoS. CDI and ST 2110 JPEG XS protocols are not currently supported by AWS CloudFormation.

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.*;
 CfnFlowOutput cfnFlowOutput = CfnFlowOutput.Builder.create(this, "MyCfnFlowOutput")
         .flowArn("flowArn")
         .protocol("protocol")
         // the properties below are optional
         .cidrAllowList(List.of("cidrAllowList"))
         .description("description")
         .destination("destination")
         .encryption(EncryptionProperty.builder()
                 .roleArn("roleArn")
                 .secretArn("secretArn")
                 // the properties below are optional
                 .algorithm("algorithm")
                 .keyType("keyType")
                 .build())
         .maxLatency(123)
         .minLatency(123)
         .name("name")
         .port(123)
         .remoteId("remoteId")
         .smoothingLatency(123)
         .streamId("streamId")
         .vpcInterfaceAttachment(VpcInterfaceAttachmentProperty.builder()
                 .vpcInterfaceName("vpcInterfaceName")
                 .build())
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnFlowOutput.Builder` A fluent builder for `CfnFlowOutput`.
`static interface`	`CfnFlowOutput.EncryptionProperty` Information about the encryption of the flow.
`static interface`	`CfnFlowOutput.VpcInterfaceAttachmentProperty` The VPC interface that you want to send your output to.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnFlowOutput(Construct scope, java.lang.String id, CfnFlowOutputProps props)` Create a new `AWS::MediaConnect::FlowOutput`.
`protected`	`CfnFlowOutput(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnFlowOutput(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrOutputArn()` The ARN of the output.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.util.List<java.lang.String>`	`getCidrAllowList()` The range of IP addresses that are allowed to initiate output requests to this flow.
`java.lang.String`	`getDescription()` A description of the output.
`java.lang.String`	`getDestination()` The IP address where you want to send the output.
`java.lang.Object`	`getEncryption()` The encryption credentials that you want to use for the output.
`java.lang.String`	`getFlowArn()` The Amazon Resource Name (ARN) of the flow this output is attached to.
`java.lang.Number`	`getMaxLatency()` The maximum latency in milliseconds.
`java.lang.Number`	`getMinLatency()` The minimum latency in milliseconds for SRT-based streams.
`java.lang.String`	`getName()` The name of the VPC interface.
`java.lang.Number`	`getPort()` The port to use when MediaConnect distributes content to the output.
`java.lang.String`	`getProtocol()` The protocol to use for the output.
`java.lang.String`	`getRemoteId()` The identifier that is assigned to the Zixi receiver.
`java.lang.Number`	`getSmoothingLatency()` The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
`java.lang.String`	`getStreamId()` The stream ID that you want to use for this transport.
`java.lang.Object`	`getVpcInterfaceAttachment()` The VPC interface that you want to send your output to.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setCidrAllowList(java.util.List<java.lang.String> value)` The range of IP addresses that are allowed to initiate output requests to this flow.
`void`	`setDescription(java.lang.String value)` A description of the output.
`void`	`setDestination(java.lang.String value)` The IP address where you want to send the output.
`void`	`setEncryption(CfnFlowOutput.EncryptionProperty value)` The encryption credentials that you want to use for the output.
`void`	`setEncryption(IResolvable value)` The encryption credentials that you want to use for the output.
`void`	`setFlowArn(java.lang.String value)` The Amazon Resource Name (ARN) of the flow this output is attached to.
`void`	`setMaxLatency(java.lang.Number value)` The maximum latency in milliseconds.
`void`	`setMinLatency(java.lang.Number value)` The minimum latency in milliseconds for SRT-based streams.
`void`	`setName(java.lang.String value)` The name of the VPC interface.
`void`	`setPort(java.lang.Number value)` The port to use when MediaConnect distributes content to the output.
`void`	`setProtocol(java.lang.String value)` The protocol to use for the output.
`void`	`setRemoteId(java.lang.String value)` The identifier that is assigned to the Zixi receiver.
`void`	`setSmoothingLatency(java.lang.Number value)` The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
`void`	`setStreamId(java.lang.String value)` The stream ID that you want to use for this transport.
`void`	`setVpcInterfaceAttachment(CfnFlowOutput.VpcInterfaceAttachmentProperty value)` The VPC interface that you want to send your output to.
`void`	`setVpcInterfaceAttachment(IResolvable value)` The VPC interface that you want to send your output to.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnFlowOutput
```
protected CfnFlowOutput(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnFlowOutput
```
protected CfnFlowOutput(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnFlowOutput
```
public CfnFlowOutput(Construct scope,
                     java.lang.String id,
                     CfnFlowOutputProps props)
```
    Create a new `AWS::MediaConnect::FlowOutput`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrOutputArn
```
public java.lang.String getAttrOutputArn()
```
    The ARN of the output.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getFlowArn
```
public java.lang.String getFlowArn()
```
    The Amazon Resource Name (ARN) of the flow this output is attached to.
  - setFlowArn
```
public void setFlowArn(java.lang.String value)
```
    The Amazon Resource Name (ARN) of the flow this output is attached to.
  - getProtocol
```
public java.lang.String getProtocol()
```
    The protocol to use for the output.
  - setProtocol
```
public void setProtocol(java.lang.String value)
```
    The protocol to use for the output.
  - getCidrAllowList
```
public java.util.List<java.lang.String> getCidrAllowList()
```
    The range of IP addresses that are allowed to initiate output requests to this flow.
    Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
  - setCidrAllowList
```
public void setCidrAllowList(java.util.List<java.lang.String> value)
```
    The range of IP addresses that are allowed to initiate output requests to this flow.
    Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
  - getDescription
```
public java.lang.String getDescription()
```
    A description of the output.
    This description is not visible outside of the current AWS account even if the account grants entitlements to other accounts.
  - setDescription
```
public void setDescription(java.lang.String value)
```
    A description of the output.
    This description is not visible outside of the current AWS account even if the account grants entitlements to other accounts.
  - getDestination
```
public java.lang.String getDestination()
```
    The IP address where you want to send the output.
  - setDestination
```
public void setDestination(java.lang.String value)
```
    The IP address where you want to send the output.
  - getEncryption
```
public java.lang.Object getEncryption()
```
    The encryption credentials that you want to use for the output.
  - setEncryption
```
public void setEncryption(IResolvable value)
```
    The encryption credentials that you want to use for the output.
  - setEncryption
```
public void setEncryption(CfnFlowOutput.EncryptionProperty value)
```
    The encryption credentials that you want to use for the output.
  - getMaxLatency
```
public java.lang.Number getMaxLatency()
```
    The maximum latency in milliseconds.
    This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
  - setMaxLatency
```
public void setMaxLatency(java.lang.Number value)
```
    The maximum latency in milliseconds.
    This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
  - getMinLatency
```
public java.lang.Number getMinLatency()
```
    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.
  - setMinLatency
```
public void setMinLatency(java.lang.Number value)
```
    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.
  - getName
```
public java.lang.String getName()
```
    The name of the VPC interface.
  - setName
```
public void setName(java.lang.String value)
```
    The name of the VPC interface.
  - getPort
```
public java.lang.Number getPort()
```
    The port to use when MediaConnect distributes content to the output.
  - setPort
```
public void setPort(java.lang.Number value)
```
    The port to use when MediaConnect distributes content to the output.
  - getRemoteId
```
public java.lang.String getRemoteId()
```
    The identifier that is assigned to the Zixi receiver.
    This parameter applies only to outputs that use Zixi pull.
  - setRemoteId
```
public void setRemoteId(java.lang.String value)
```
    The identifier that is assigned to the Zixi receiver.
    This parameter applies only to outputs that use Zixi pull.
  - getSmoothingLatency
```
public java.lang.Number getSmoothingLatency()
```
    The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
  - setSmoothingLatency
```
public void setSmoothingLatency(java.lang.Number value)
```
    The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
  - getStreamId
```
public java.lang.String getStreamId()
```
    The stream ID that you want to use for this transport.
    This parameter applies only to Zixi and SRT caller-based streams.
  - setStreamId
```
public void setStreamId(java.lang.String value)
```
    The stream ID that you want to use for this transport.
    This parameter applies only to Zixi and SRT caller-based streams.
  - getVpcInterfaceAttachment
```
public java.lang.Object getVpcInterfaceAttachment()
```
    The VPC interface that you want to send your output to.
  - setVpcInterfaceAttachment
```
public void setVpcInterfaceAttachment(IResolvable value)
```
    The VPC interface that you want to send your output to.
  - setVpcInterfaceAttachment
```
public void setVpcInterfaceAttachment(CfnFlowOutput.VpcInterfaceAttachmentProperty value)
```
    The VPC interface that you want to send your output to.

Class CfnFlowOutput

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnFlowOutput

CfnFlowOutput

CfnFlowOutput

Method Detail

inspect

renderProperties

getAttrOutputArn

getCfnProperties

getFlowArn

setFlowArn

getProtocol

setProtocol

getCidrAllowList

setCidrAllowList

getDescription

setDescription

getDestination

setDestination

getEncryption

setEncryption

setEncryption

getMaxLatency

setMaxLatency

getMinLatency

setMinLatency

getName

setName

getPort

setPort

getRemoteId

setRemoteId

getSmoothingLatency

setSmoothingLatency

getStreamId

setStreamId

getVpcInterfaceAttachment

setVpcInterfaceAttachment

setVpcInterfaceAttachment