CfnFlow.SourceProperty

All Known Implementing Classes:: CfnFlow.SourceProperty.Jsii$Proxy

Enclosing class:: CfnFlow

public static interface CfnFlow.SourceProperty

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.

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.*;
 SourceProperty sourceProperty = SourceProperty.builder()
         .decryption(EncryptionProperty.builder()
                 .roleArn("roleArn")
                 // the properties below are optional
                 .algorithm("algorithm")
                 .constantInitializationVector("constantInitializationVector")
                 .deviceId("deviceId")
                 .keyType("keyType")
                 .region("region")
                 .resourceId("resourceId")
                 .secretArn("secretArn")
                 .url("url")
                 .build())
         .description("description")
         .entitlementArn("entitlementArn")
         .ingestIp("ingestIp")
         .ingestPort(123)
         .maxBitrate(123)
         .maxLatency(123)
         .minLatency(123)
         .name("name")
         .protocol("protocol")
         .sourceArn("sourceArn")
         .sourceIngestPort("sourceIngestPort")
         .streamId("streamId")
         .vpcInterfaceName("vpcInterfaceName")
         .whitelistCidr("whitelistCidr")
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`CfnFlow.SourceProperty.Builder` A builder for `CfnFlow.SourceProperty`
`static class`	`CfnFlow.SourceProperty.Jsii$Proxy` An implementation for `CfnFlow.SourceProperty`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static CfnFlow.SourceProperty.Builder`	`builder()`
`default java.lang.Object`	`getDecryption()` The type of encryption that is used on the content ingested from the source.
`default java.lang.String`	`getDescription()` A description of the source.
`default java.lang.String`	`getEntitlementArn()` The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account.
`default java.lang.String`	`getIngestIp()` The IP address that the flow listens on for incoming content.
`default java.lang.Number`	`getIngestPort()` The port that the flow listens on for incoming content.
`default java.lang.Number`	`getMaxBitrate()` The maximum bitrate for RIST, RTP, and RTP-FEC streams.
`default java.lang.Number`	`getMaxLatency()` The maximum latency in milliseconds for a RIST or Zixi-based source.
`default java.lang.Number`	`getMinLatency()` The minimum latency in milliseconds for SRT-based streams.
`default java.lang.String`	`getName()` The name of the source.
`default java.lang.String`	`getProtocol()` The protocol that is used by the source.
`default java.lang.String`	`getSourceArn()` The ARN of the source.
`default java.lang.String`	`getSourceIngestPort()` The port that the flow will be listening on for incoming content.
`default java.lang.String`	`getStreamId()` The stream ID that you want to use for the transport.
`default java.lang.String`	`getVpcInterfaceName()` The name of the VPC interface that the source content comes from.
`default java.lang.String`	`getWhitelistCidr()` The range of IP addresses that are allowed to contribute content to your source.

- Method Detail
  - getDecryption
```
default java.lang.Object getDecryption()
```
    The type of encryption that is used on the content ingested from the source.
  - getDescription
```
default java.lang.String getDescription()
```
    A description of the source.
    This description is not visible outside of the current AWS account.
  - getEntitlementArn
```
default java.lang.String getEntitlementArn()
```
    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.
  - getIngestIp
```
default java.lang.String getIngestIp()
```
    The IP address that the flow listens on for incoming content.
  - getIngestPort
```
default java.lang.Number getIngestPort()
```
    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.
  - getMaxBitrate
```
default java.lang.Number getMaxBitrate()
```
    The maximum bitrate for RIST, RTP, and RTP-FEC streams.
  - getMaxLatency
```
default java.lang.Number getMaxLatency()
```
    The maximum latency in milliseconds for a RIST or Zixi-based source.
  - getMinLatency
```
default 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.
  - getName
```
default java.lang.String getName()
```
    The name of the source.
  - getProtocol
```
default java.lang.String getProtocol()
```
    The protocol that is used by the source.
    For a full list of available protocols, see: Source protocols in the AWS Elemental MediaConnect API Reference .
  - getSourceArn
```
default java.lang.String getSourceArn()
```
    The ARN of the source.
  - getSourceIngestPort
```
default java.lang.String getSourceIngestPort()
```
    The port that the flow will be listening on for incoming content.
  - getStreamId
```
default java.lang.String getStreamId()
```
    The stream ID that you want to use for the transport.
    This parameter applies only to Zixi-based streams.
  - getVpcInterfaceName
```
default java.lang.String getVpcInterfaceName()
```
    The name of the VPC interface that the source content comes from.
  - getWhitelistCidr
```
default java.lang.String getWhitelistCidr()
```
    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.
  - builder
```
static CfnFlow.SourceProperty.Builder builder()
```
    Returns:
    
    a CfnFlow.SourceProperty.Builder of CfnFlow.SourceProperty

Interface CfnFlow.SourceProperty

Nested Class Summary

Method Summary

Method Detail

getDecryption

getDescription

getEntitlementArn

getIngestIp

getIngestPort

getMaxBitrate

getMaxLatency

getMinLatency

getName

getProtocol

getSourceArn

getSourceIngestPort

getStreamId

getVpcInterfaceName

getWhitelistCidr

builder