@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-25T18:28:58.948Z") public class CfnFlow extends CfnResource implements IInspectable
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.
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.*; CfnFlow cfnFlow = CfnFlow.Builder.create(this, "MyCfnFlow") .name("name") .source(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") .senderControlPort(123) .senderIpAddress("senderIpAddress") .sourceArn("sourceArn") .sourceIngestPort("sourceIngestPort") .sourceListenerAddress("sourceListenerAddress") .sourceListenerPort(123) .streamId("streamId") .vpcInterfaceName("vpcInterfaceName") .whitelistCidr("whitelistCidr") .build()) // the properties below are optional .availabilityZone("availabilityZone") .sourceFailoverConfig(FailoverConfigProperty.builder() .failoverMode("failoverMode") .recoveryWindow(123) .sourcePriority(SourcePriorityProperty.builder() .primarySource("primarySource") .build()) .state("state") .build()) .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnFlow.Builder
A fluent builder for
CfnFlow . |
static interface |
CfnFlow.EncryptionProperty
Information about the encryption of the flow.
|
static interface |
CfnFlow.FailoverConfigProperty
The settings for source failover.
|
static interface |
CfnFlow.SourcePriorityProperty
The priority you want to assign to a source.
|
static interface |
CfnFlow.SourceProperty
The details of the sources of the flow.
|
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 |
---|---|
|
CfnFlow(Construct scope,
java.lang.String id,
CfnFlowProps props)
Create a new `AWS::MediaConnect::Flow`.
|
protected |
CfnFlow(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnFlow(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrFlowArn()
The Amazon Resource Name (ARN) of the flow.
|
java.lang.String |
getAttrFlowAvailabilityZone()
The Availability Zone that the flow was created in.
|
java.lang.String |
getAttrSourceIngestIp()
The IP address that the flow listens on for incoming content.
|
java.lang.String |
getAttrSourceSourceArn()
The ARN of the source.
|
java.lang.String |
getAttrSourceSourceIngestPort()
The port that the flow will be listening on for incoming content.
|
java.lang.String |
getAvailabilityZone()
The Availability Zone that you want to create the flow in.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getName()
The name of the flow.
|
java.lang.Object |
getSource()
The settings for the source that you want to use for the new flow.
|
java.lang.Object |
getSourceFailoverConfig()
The settings for source failover.
|
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 |
setAvailabilityZone(java.lang.String value)
The Availability Zone that you want to create the flow in.
|
void |
setName(java.lang.String value)
The name of the flow.
|
void |
setSource(CfnFlow.SourceProperty value)
The settings for the source that you want to use for the new flow.
|
void |
setSource(IResolvable value)
The settings for the source that you want to use for the new flow.
|
void |
setSourceFailoverConfig(CfnFlow.FailoverConfigProperty value)
The settings for source failover.
|
void |
setSourceFailoverConfig(IResolvable value)
The settings for source failover.
|
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 CfnFlow(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnFlow(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnFlow(Construct scope, java.lang.String id, CfnFlowProps 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 getAttrFlowArn()
public java.lang.String getAttrFlowAvailabilityZone()
These options are limited to the Availability Zones within the current AWS Region.
public java.lang.String getAttrSourceIngestIp()
public java.lang.String getAttrSourceSourceArn()
public java.lang.String getAttrSourceSourceIngestPort()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.Object getSource()
public void setSource(CfnFlow.SourceProperty value)
public void setSource(IResolvable value)
public java.lang.String getAvailabilityZone()
These options are limited to the Availability Zones within the current AWS Region.
public void setAvailabilityZone(java.lang.String value)
These options are limited to the Availability Zones within the current AWS Region.
public java.lang.Object getSourceFailoverConfig()
public void setSourceFailoverConfig(IResolvable value)
public void setSourceFailoverConfig(CfnFlow.FailoverConfigProperty value)