VpcLink

An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).

APIs.ioEngineeringPlatform

Properties

Name Type Description
id object
name object
description object
targetArns object
status object
statusMessage object
tags object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-vpclink-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/VpcLink",
  "title": "VpcLink",
  "type": "object",
  "properties": {
    "id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The identifier of the VpcLink. It is used in an Integration to reference this VpcLink."
        }
      ]
    },
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The name used to label and identify the VPC link."
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The description of the VPC link."
        }
      ]
    },
    "targetArns": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ListOfString"
        },
        {
          "description": "The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner."
        }
      ]
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VpcLinkStatus"
        },
        {
          "description": "The status of the VPC link. The valid values are <code>AVAILABLE</code>, <code>PENDING</code>, <code>DELETING</code>, or <code>FAILED</code>. Deploying an API will wait if the status is <code>PENDING</code> and will fail if the status is <code>DELETING</code>. "
        }
      ]
    },
    "statusMessage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "A description about the VPC link status."
        }
      ]
    },
    "tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOfStringToString"
        },
        {
          "description": "The collection of tags. Each tag element is associated with a given resource."
        }
      ]
    }
  },
  "description": "An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC)."
}