NSX-T Data Center REST API

AwsComputeVpcStatus (type)

{
  "additionalProperties": false, 
  "description": "Stores onboard and offboard status of AWS VPC. There are 4 states in onboarding a VPC using transit VPC and the corresponding states in sequence are VALIDATING_ENVIRONMENT, CREATING_SECURITY_GROUPS, CONFIGURING_GATEWAY and ONBOARD_SUCCESSFUL. There are 3 states in offboarding a VPC and the corresponding states in sequence are UNCONFIGURING_GATEWAY, DELETING_SECURITY_GROUPS and OFFBOARD_SUCCESSFUL. The state of failure in onboarding or offboarding is indicated by ONBOARD_FAILED and OFFBOARD_FAILED.", 
  "extends": {
    "$ref": "VirtualPrivateCloudStatus
  }, 
  "id": "AwsComputeVpcStatus", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "configuration": {
      "$ref": "AwsVpcConfig, 
      "description": "Stores AWS VPC configuration.", 
      "required": false, 
      "title": "AWS VPC Config"
    }, 
    "error_code": {
      "description": "Error code related to virtual private cloud Onboard/Offboard failure.", 
      "readonly": true, 
      "required": false, 
      "title": "Error Code", 
      "type": "integer"
    }, 
    "error_message": {
      "description": "Error message related to virtual private cloud Onboard/Offboard failure.", 
      "readonly": true, 
      "required": false, 
      "title": "Error Message", 
      "type": "string"
    }, 
    "offboard_step": {
      "description": "Stores the different states of virtual private cloud while offboarding from a transit virtual private cloud.", 
      "enum": [
        "UNCONFIGURING_GATEWAY", 
        "DELETING_SECURITY_GROUPS", 
        "OFFBOARD_SUCCESSFUL", 
        "OFFBOARD_FAILED", 
        "NOT_APPLICABLE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "States of Virtual Private Cloud While OffBoard", 
      "type": "string"
    }, 
    "onboard_step": {
      "description": "Stores the different states of virtual private cloud while onboarding using a transit virtual private cloud.", 
      "enum": [
        "VALIDATING_ENVIRONMENT", 
        "CREATING_SECURITY_GROUPS", 
        "CONFIGURING_GATEWAY", 
        "ONBOARD_SUCCESSFUL", 
        "ONBOARD_FAILED", 
        "NOT_APPLICABLE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "States of Virtual Private Cloud While Onboard", 
      "type": "string"
    }, 
    "status": {
      "description": "Indicates the status of a virtual private cloud. UP: virtual private cloud is NSX managed. DOWN: virtual private cloud is NSX managed with errors. ONBOARDING: virtual private cloud is in the process of   onboarding using a transit virtual private cloud. OFFBOARDING: virtual private cloud is in the process of    offboarding from a transit virtual private cloud. NOT_APPLICABLE: virtual private cloud is NSX unmanaged.", 
      "enum": [
        "UP", 
        "DOWN", 
        "ONBOARDING", 
        "OFFBOARDING", 
        "NOT_APPLICABLE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Virtual Private Cloud Status", 
      "type": "string"
    }, 
    "virtual_private_cloud_name": {
      "description": "Name of the transit virtual private cloud.", 
      "readonly": true, 
      "title": "Virtual Private Cloud Name", 
      "type": "string"
    }
  }, 
  "title": "VPC Status", 
  "type": "object"
}