@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-31T18:36:48.839Z") public class CfnFlowOutput extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnFlowOutput(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnFlowOutput(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnFlowOutput(Construct scope, java.lang.String id, CfnFlowOutputProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrOutputArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getFlowArn()
public void setFlowArn(java.lang.String value)
public java.lang.String getProtocol()
public void setProtocol(java.lang.String value)
public java.util.List<java.lang.String> getCidrAllowList()
Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
public void setCidrAllowList(java.util.List<java.lang.String> value)
Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
public java.lang.String getDescription()
This description is not visible outside of the current AWS account even if the account grants entitlements to other accounts.
public void setDescription(java.lang.String value)
This description is not visible outside of the current AWS account even if the account grants entitlements to other accounts.
public java.lang.String getDestination()
public void setDestination(java.lang.String value)
public java.lang.Object getEncryption()
public void setEncryption(IResolvable value)
public void setEncryption(CfnFlowOutput.EncryptionProperty value)
public java.lang.Number getMaxLatency()
This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
public void setMaxLatency(java.lang.Number value)
This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
public java.lang.Number getMinLatency()
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.
public void setMinLatency(java.lang.Number value)
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.
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.Number getPort()
public void setPort(java.lang.Number value)
public java.lang.String getRemoteId()
This parameter applies only to outputs that use Zixi pull.
public void setRemoteId(java.lang.String value)
This parameter applies only to outputs that use Zixi pull.
public java.lang.Number getSmoothingLatency()
public void setSmoothingLatency(java.lang.Number value)
public java.lang.String getStreamId()
This parameter applies only to Zixi and SRT caller-based streams.
public void setStreamId(java.lang.String value)
This parameter applies only to Zixi and SRT caller-based streams.
public java.lang.Object getVpcInterfaceAttachment()
public void setVpcInterfaceAttachment(IResolvable value)
public void setVpcInterfaceAttachment(CfnFlowOutput.VpcInterfaceAttachmentProperty value)