software.amazon.awscdk.services.mediaconnect

Class CfnFlowVpcInterface

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.mediaconnect.CfnFlowVpcInterface

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:36.975Z")
 @Stability(value=Stable)
public class CfnFlowVpcInterface
extends CfnResource
implements IInspectable

A CloudFormation `AWS::MediaConnect::FlowVpcInterface`.

The AWS::MediaConnect::FlowVpcInterface resource is a connection between your AWS Elemental MediaConnect flow and a virtual private cloud (VPC) that you created using the Amazon Virtual Private Cloud service.

To avoid streaming your content over the public internet, you can add up to two VPC interfaces to your flow and use those connections to transfer content between your VPC and MediaConnect.

You can update an existing flow to add a VPC interface. If you haven’t created the flow yet, you must create the flow with a temporary standard source by doing the following:

• Use CloudFormation to create a flow with a standard source that uses to the flow’s public IP address.
• Use CloudFormation to create a 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.*;
 CfnFlowVpcInterface cfnFlowVpcInterface = CfnFlowVpcInterface.Builder.create(this, "MyCfnFlowVpcInterface")
         .flowArn("flowArn")
         .name("name")
         .roleArn("roleArn")
         .securityGroupIds(List.of("securityGroupIds"))
         .subnetId("subnetId")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnFlowVpcInterface.Builder A fluent builder for CfnFlowVpcInterface.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

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
	CfnFlowVpcInterface(Construct scope, String id, CfnFlowVpcInterfaceProps props) Create a new `AWS::MediaConnect::FlowVpcInterface`.
protected	CfnFlowVpcInterface(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFlowVpcInterface(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
List<String>	getAttrNetworkInterfaceIds() The IDs of the network interfaces that MediaConnect created in your account.
protected Map<String,Object>	getCfnProperties()
String	getFlowArn() The Amazon Resource Name (ARN) of the flow.
String	getName() The name of the VPC Interface.
String	getRoleArn() The Amazon Resource Name (ARN) of the role that you created when you set up MediaConnect as a trusted service.
List<String>	getSecurityGroupIds() The VPC security groups that you want MediaConnect to use for your VPC configuration.
String	getSubnetId() The subnet IDs that you want to use for your VPC interface.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setFlowArn(String value) The Amazon Resource Name (ARN) of the flow.
void	setName(String value) The name of the VPC Interface.
void	setRoleArn(String value) The Amazon Resource Name (ARN) of the role that you created when you set up MediaConnect as a trusted service.
void	setSecurityGroupIds(List<String> value) The VPC security groups that you want MediaConnect to use for your VPC configuration.
void	setSubnetId(String value) The subnet IDs that you want to use for your VPC interface.

Methods inherited from class software.amazon.awscdk.core.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.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

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

CfnFlowVpcInterface

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

CfnFlowVpcInterface

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

CfnFlowVpcInterface

@Stability(value=Stable)
public CfnFlowVpcInterface(@NotNull
                                                    Construct scope,
                                                    @NotNull
                                                    String id,
                                                    @NotNull
                                                    CfnFlowVpcInterfaceProps props)

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

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.

getAttrNetworkInterfaceIds

@Stability(value=Stable)
 @NotNull
public List<String> getAttrNetworkInterfaceIds()

The IDs of the network interfaces that MediaConnect created in your account.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getFlowArn

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

The Amazon Resource Name (ARN) of the flow.

setFlowArn

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

The Amazon Resource Name (ARN) of the flow.

getName

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

The name of the VPC Interface.

This value must be unique within the current flow.

setName

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

The name of the VPC Interface.

This value must be unique within the current flow.

getRoleArn

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

The Amazon Resource Name (ARN) of the role that you created when you set up MediaConnect as a trusted service.

setRoleArn

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

The Amazon Resource Name (ARN) of the role that you created when you set up MediaConnect as a trusted service.

getSecurityGroupIds

@Stability(value=Stable)
 @NotNull
public List<String> getSecurityGroupIds()

The VPC security groups that you want MediaConnect to use for your VPC configuration.

You must include at least one security group in the request.

setSecurityGroupIds

@Stability(value=Stable)
public void setSecurityGroupIds(@NotNull
                                                         List<String> value)

The VPC security groups that you want MediaConnect to use for your VPC configuration.

You must include at least one security group in the request.

getSubnetId

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

The subnet IDs that you want to use for your VPC interface.

A range of IP addresses in your VPC. When you create your VPC, you specify a range of IPv4 addresses for the VPC in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. This is the primary CIDR block for your VPC. When you create a subnet for your VPC, you specify the CIDR block for the subnet, which is a subset of the VPC CIDR block.

The subnets that you use across all VPC interfaces on the flow must be in the same Availability Zone as the flow.

setSubnetId

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

The subnet IDs that you want to use for your VPC interface.

A range of IP addresses in your VPC. When you create your VPC, you specify a range of IPv4 addresses for the VPC in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. This is the primary CIDR block for your VPC. When you create a subnet for your VPC, you specify the CIDR block for the subnet, which is a subset of the VPC CIDR block.

The subnets that you use across all VPC interfaces on the flow must be in the same Availability Zone as the flow.