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.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:18.475Z")
 @Stability(value=Stable)
public class CfnFlow
extends CfnResource
implements IInspectable

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

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 Example:
static interface	CfnFlow.FailoverConfigProperty Example:
static interface	CfnFlow.SourceProperty Example:

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()
String	getAttrFlowAvailabilityZone()
String	getAttrSourceIngestIp()
String	getAttrSourceSourceArn()
String	getAttrSourceSourceIngestPort()
String	getAvailabilityZone() `AWS::MediaConnect::Flow.AvailabilityZone`.
protected Map<String,Object>	getCfnProperties()
String	getName() `AWS::MediaConnect::Flow.Name`.
Object	getSource() `AWS::MediaConnect::Flow.Source`.
Object	getSourceFailoverConfig() `AWS::MediaConnect::Flow.SourceFailoverConfig`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAvailabilityZone(String value) `AWS::MediaConnect::Flow.AvailabilityZone`.
void	setName(String value) `AWS::MediaConnect::Flow.Name`.
void	setSource(CfnFlow.SourceProperty value) `AWS::MediaConnect::Flow.Source`.
void	setSource(IResolvable value) `AWS::MediaConnect::Flow.Source`.
void	setSourceFailoverConfig(CfnFlow.FailoverConfigProperty value) `AWS::MediaConnect::Flow.SourceFailoverConfig`.
void	setSourceFailoverConfig(IResolvable value) `AWS::MediaConnect::Flow.SourceFailoverConfig`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, 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()

getAttrFlowAvailabilityZone

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

getAttrSourceIngestIp

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

getAttrSourceSourceArn

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

getAttrSourceSourceIngestPort

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

getAvailabilityZone

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

`AWS::MediaConnect::Flow.AvailabilityZone`.

setAvailabilityZone

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

`AWS::MediaConnect::Flow.AvailabilityZone`.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getName

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

`AWS::MediaConnect::Flow.Name`.

setName

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

`AWS::MediaConnect::Flow.Name`.

getSource

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

`AWS::MediaConnect::Flow.Source`.

setSource

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

`AWS::MediaConnect::Flow.Source`.

setSource

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

`AWS::MediaConnect::Flow.Source`.

getSourceFailoverConfig

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

`AWS::MediaConnect::Flow.SourceFailoverConfig`.

setSourceFailoverConfig

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

`AWS::MediaConnect::Flow.SourceFailoverConfig`.

setSourceFailoverConfig

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

`AWS::MediaConnect::Flow.SourceFailoverConfig`.