URI HTTP methods Schemas Properties See also

VPC interfaces: add

URI

/v1/flows/flowArn/vpcInterfaces

HTTP methods

POST

Operation ID: AddFlowVpcInterfaces

Adds VPC interfaces to a flow.

A virtual private cloud (VPC) based on the Amazon Virtual Private Cloud service is your private, logically isolated network in the AWS Cloud. 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.

Path parameters
Name	Type	Required	Description
`flowArn`	String	True	The Amazon Resource Name (ARN) of the flow.

Responses
Status code	Response model	Description
`201`	`AddFlowVpcInterfacesResponse`	MediaConnect created the new resource successfully.
`400`	`ResponseError`	The request that you submitted is not valid.
`403`	`ResponseError`	You don't have the required permissions to perform this operation.
`404`	`ResponseError`	MediaConnect did not find the resource that you specified in the request.
`429`	`ResponseError`	You have exceeded the service request rate limit for your MediaConnect account.
`500`	`ResponseError`	MediaConnect can't fulfill your request because it encountered an unexpected condition.
`503`	`ResponseError`	MediaConnect is currently unavailable. Try again later.

Schemas

Request bodies


{
  "vpcInterfaces": [
    {
      "subnetId": "string",
      "roleArn": "string",
      "securityGroupIds": [
        "string"
      ],
      "name": "string",
      "networkInterfaceType": enum
    }
  ]
}

Response bodies


{
  "flowArn": "string",
  "vpcInterfaces": [
    {
      "subnetId": "string",
      "roleArn": "string",
      "securityGroupIds": [
        "string"
      ],
      "name": "string",
      "networkInterfaceType": enum,
      "networkInterfaceIds": [
        "string"
      ]
    }
  ]
}


{
  "message": "string"
}

Properties

AddFlowVpcInterfacesRequest

Adds VPC interfaces to an existing flow.

Property	Type	Required	Description
`vpcInterfaces`	Array of type VpcInterfaceRequest	True	A list of VPC interfaces that you want to add.

AddFlowVpcInterfacesResponse

The result of a successful AddFlowVpcInterfaces request. The response includes the details of the newly added VPC interfaces.

Property	Type	Required	Description
`flowArn`	string	True	The ARN of the flow that these VPC interfaces were added to.
`vpcInterfaces`	Array of type VpcInterface	True	The details of the newly added VPC interfaces.

ResponseError

An exception raised by MediaConnect when you submit a request that cannot be completed. For more information, see the error message and documentation for the operation.

Property	Type	Required	Description
`message`	string	True	The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.

VpcInterface

The details of a VPC interface.

Property	Type	Required	Description
`name`	string	True	The name for the VPC interface. This name must be unique within the flow.
`networkInterfaceIds`	Array of type string	True	The IDs of the network interfaces that MediaConnect created in your account.
`networkInterfaceType`	string Values: `ena \| efa`	True	The type of network interface.
`roleArn`	string	True	The ARN of the IAM role that you created when you set up MediaConnect as a trusted service.
`securityGroupIds`	Array of type string	True	A virtual firewall to control inbound and outbound traffic.
`subnetId`	string	True	The subnet IDs that you specified for your VPC interface. A subnet ID is 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.

VpcInterfaceRequest

The details of the VPC interfaces that you want to add to the flow.

Property	Type	Required	Description
`name`	string	True	The name of the VPC Interface. This value must be unique within the current flow.
`networkInterfaceType`	string Values: `ena \| efa`	False	The type of network adapter that you want MediaConnect to use on this interface. If you don't set this value, it defaults to ENA.
`roleArn`	string	True	The Amazon Resource Name (ARN) of the role that you created when you set up MediaConnect as a trusted service.
`securityGroupIds`	Array of type string	True	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.
`subnetId`	string	True	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.