Package software.amazon.awscdk.services.mediaconnect

Interface CfnFlowProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlowProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:09.706Z")
@Stability(Stable)
public interface CfnFlowProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnFlow.

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.*;
 CfnFlowProps cfnFlowProps = CfnFlowProps.builder()
         .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")
                 .gatewayBridgeSource(GatewayBridgeSourceProperty.builder()
                         .bridgeArn("bridgeArn")
                         // the properties below are optional
                         .vpcInterfaceAttachment(VpcInterfaceAttachmentProperty.builder()
                                 .vpcInterfaceName("vpcInterfaceName")
                                 .build())
                         .build())
                 .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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFlowProps.Builder	A builder for CfnFlowProps
static final class	CfnFlowProps.Jsii$Proxy	An implementation for CfnFlowProps

Method Summary

Modifier and Type	Method	Description
static CfnFlowProps.Builder	builder()
default String	getAvailabilityZone()	The Availability Zone that you want to create the flow in.
String	getName()	The name of the flow.
Object	getSource()	The settings for the source that you want to use for the new flow.
default Object	getSourceFailoverConfig()	The settings for source failover.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the flow.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-name

getSource

@Stability(Stable)
@NotNull
Object getSource()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-source

getAvailabilityZone

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-availabilityzone

getSourceFailoverConfig

@Stability(Stable)
@Nullable
default Object getSourceFailoverConfig()

The settings for source failover.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-sourcefailoverconfig

builder

@Stability(Stable)
static CfnFlowProps.Builder builder()

Returns:

a CfnFlowProps.Builder of CfnFlowProps