NSX-T Data Center REST API
AwsVpc (schema)
Vpc Information
| Name | Description | Type | Notes |
|---|---|---|---|
| _create_time | Timestamp of resource creation | EpochMsTimestamp | Readonly Sortable |
| _create_user | ID of the user who created this resource | string | Readonly |
| _last_modified_time | Timestamp of last modification | EpochMsTimestamp | Readonly Sortable |
| _last_modified_user | ID of the user who last modified this resource | string | Readonly |
| _links | References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink | Readonly |
| _protection | Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. |
string | Readonly |
| _revision | Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. |
int | |
| _schema | Schema for this resource | string | Readonly |
| _self | Link to this resource | SelfResourceLink | Readonly |
| _system_owned | Indicates system owned resource | boolean | Readonly |
| agent_info | Aws Agent Information Array of agent install and download instructions for various OS types. |
array of AgentInfo | Readonly |
| ami_id | AMI ID Amazon Machine Image is a special type of virtual appliance that is used to create a virtual machine with the Amazon Elastic Compute Cloud. It serves as the basic unit of deployment for services delivered using Amazon EC2 |
string | Readonly |
| associated_account_ids | Associated AWS Account IDs Array of associated AWS account IDs. |
array of string | |
| associated_transit_vpc | Associated AWS Transit VPC Stores the VPC ID and associated account IDs of the transit VPC. This property describes the associated transit VPC for a given AWS compute VPC. |
AwsTransitVpcInfo | Readonly |
| cidr | IPV4 CIDR Block for the Vpc This field is DEPRECATED as AWS started supporting multiple CIDR blocks per VPC. This field will return only the first CIDR block from the response received from AWS. Please use cidr_blocks to see the multiple CIDR blocks associated with the VPC. |
string | Deprecated Readonly Format: ipv4-cidr-block |
| cidr_blocks | IPv4 CIDR Block IPv4 CIDR Block of the virtual network. |
array of CidrBlock | Readonly |
| description | Description of this resource | string | Maximum length: 1024 Sortable |
| display_name | Identifier to use when displaying entity in logs or GUI Defaults to ID if not set |
string | Maximum length: 255 Sortable |
| gateway_info | Gateway details for the Vpc | AwsGatewayInfo | Readonly |
| id | Unique identifier of this resource | string | Sortable |
| instance_stats | Managed, unmanaged and error instance counts for the Vpc | InstanceStats | Readonly |
| is_management_vpc | Flag to identify if this is the management Vpc | boolean | Readonly Default: "False" |
| managed_vpcs | Array of NSX Managed Compute VPCs Array of compute VPCs managed by a transit VPC. This property describes array of managed compute VPC for a given transit VPC. |
array of ManagedVpcInfo | Readonly |
| op_status | AWS VPC Operational Status Operational status of the VPC. |
AwsVpcOpStatus | Readonly |
| region_id | Id of the AWS region | string | Readonly |
| resource_type | Must be set to the value AwsVpc | string | |
| tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |
| transport_zones | Transport zones for the Vpc | array of TransportZoneInfo | Readonly |
| vpc_status | AWS Compute VPC Status Stores onboard and offboard states and corresponding error messages and error code related to AWS compute VPC. The status for a transit VPC should be obtained from gateway_info. |
AwsComputeVpcStatus | Readonly |