Amazon MediaConnect · JSON Structure

Mediaconnect Api Vpc Interface Request Structure

Desired VPC Interface for a Flow

Type: object Properties: 5 Required: 4
BroadcastingLive VideoMediaMedia Transport

VpcInterfaceRequest is a JSON Structure definition published by Amazon MediaConnect, describing 5 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Name NetworkInterfaceType RoleArn SecurityGroupIds SubnetId

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-mediaconnect/refs/heads/main/json-structure/mediaconnect-api-vpc-interface-request-structure.json",
  "name": "VpcInterfaceRequest",
  "type": "object",
  "description": "Desired VPC Interface for a Flow",
  "properties": {
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "name"
          },
          "description": "The name of the VPC Interface. This value must be unique within the current flow."
        }
      ]
    },
    "NetworkInterfaceType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NetworkInterfaceType"
        },
        {
          "xml": {
            "name": "networkInterfaceType"
          },
          "description": "The type of network interface. If this value is not included in the request, MediaConnect uses ENA as the networkInterfaceType."
        }
      ]
    },
    "RoleArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "roleArn"
          },
          "description": "Role Arn MediaConnect can assumes to create ENIs in customer's account"
        }
      ]
    },
    "SecurityGroupIds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__listOf__string"
        },
        {
          "xml": {
            "name": "securityGroupIds"
          },
          "description": "Security Group IDs to be used on ENI."
        }
      ]
    },
    "SubnetId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "subnetId"
          },
          "description": "Subnet must be in the AZ of the Flow"
        }
      ]
    }
  },
  "required": [
    "SubnetId",
    "SecurityGroupIds",
    "RoleArn",
    "Name"
  ]
}