software.amazon.awscdk.services.mediaconnect

Class CfnFlow

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.mediaconnect.CfnFlow

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.753Z")
 @Stability(value=Stable)
public class CfnFlow
extends CfnResource
implements IInspectable

A CloudFormation `AWS::MediaConnect::Flow`.

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")
                 .sourceArn("sourceArn")
                 .sourceIngestPort("sourceIngestPort")
                 .streamId("streamId")
                 .vpcInterfaceName("vpcInterfaceName")
                 .whitelistCidr("whitelistCidr")
                 .build())
         // the properties below are optional
         .availabilityZone("availabilityZone")
         .sourceFailoverConfig(FailoverConfigProperty.builder()
                 .recoveryWindow(123)
                 .state("state")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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.SourceProperty The details of the sources of the flow.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnFlow(software.constructs.Construct scope, 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)

Method Summary

Modifier and Type	Method and Description
String	getAttrFlowArn() The Amazon Resource Name (ARN) of the flow.
String	getAttrFlowAvailabilityZone() The Availability Zone that the flow was created in.
String	getAttrSourceIngestIp() The IP address that the flow listens on for incoming content.
String	getAttrSourceSourceArn() The ARN of the source.
String	getAttrSourceSourceIngestPort() The port that the flow will be listening on for incoming content.
String	getAvailabilityZone() The Availability Zone that you want to create the flow in.
protected Map<String,Object>	getCfnProperties()
String	getName() The name of the flow.
Object	getSource() The settings for the source that you want to use for the new flow.
Object	getSourceFailoverConfig() The settings for source failover.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAvailabilityZone(String value) The Availability Zone that you want to create the flow in.
void	setName(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.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnFlow

protected CfnFlow(software.amazon.jsii.JsiiObjectRef objRef)

CfnFlow

protected CfnFlow(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnFlow

@Stability(value=Stable)
public CfnFlow(@NotNull
                                        software.constructs.Construct scope,
                                        @NotNull
                                        String id,
                                        @NotNull
                                        CfnFlowProps props)

Create a new `AWS::MediaConnect::Flow`.

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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrFlowArn

@Stability(value=Stable)
 @NotNull
public String getAttrFlowArn()

The Amazon Resource Name (ARN) of the flow.

getAttrFlowAvailabilityZone

@Stability(value=Stable)
 @NotNull
public String getAttrFlowAvailabilityZone()

The Availability Zone that the flow was created in.

These options are limited to the Availability Zones within the current AWS Region.

getAttrSourceIngestIp

@Stability(value=Stable)
 @NotNull
public String getAttrSourceIngestIp()

The IP address that the flow listens on for incoming content.

getAttrSourceSourceArn

@Stability(value=Stable)
 @NotNull
public String getAttrSourceSourceArn()

The ARN of the source.

getAttrSourceSourceIngestPort

@Stability(value=Stable)
 @NotNull
public String getAttrSourceSourceIngestPort()

The port that the flow will be listening on for incoming content.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the flow.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the flow.

getSource

@Stability(value=Stable)
 @NotNull
public Object getSource()

The settings for the source that you want to use for the new flow.

setSource

@Stability(value=Stable)
public void setSource(@NotNull
                                               CfnFlow.SourceProperty value)

The settings for the source that you want to use for the new flow.

setSource

@Stability(value=Stable)
public void setSource(@NotNull
                                               IResolvable value)

The settings for the source that you want to use for the new flow.

getAvailabilityZone

@Stability(value=Stable)
 @Nullable
public String getAvailabilityZone()

The Availability Zone that you want to create the flow in.

These options are limited to the Availability Zones within the current AWS Region.

setAvailabilityZone

@Stability(value=Stable)
public void setAvailabilityZone(@Nullable
                                                         String value)

The Availability Zone that you want to create the flow in.

These options are limited to the Availability Zones within the current AWS Region.

getSourceFailoverConfig

@Stability(value=Stable)
 @Nullable
public Object getSourceFailoverConfig()

The settings for source failover.

setSourceFailoverConfig

@Stability(value=Stable)
public void setSourceFailoverConfig(@Nullable
                                                             CfnFlow.FailoverConfigProperty value)

The settings for source failover.

setSourceFailoverConfig

@Stability(value=Stable)
public void setSourceFailoverConfig(@Nullable
                                                             IResolvable value)

The settings for source failover.