Amazon VPC · Schema

Subnet

Describes a subnet

NetworkingPrivate CloudSecuritySubnetsVPC

Properties

Name Type Description
subnetId string The ID of the subnet
subnetArn string The Amazon Resource Name (ARN) of the subnet
vpcId string The ID of the VPC the subnet is in
state string The current state of the subnet
cidrBlock string The IPv4 CIDR block assigned to the subnet
availabilityZone string The Availability Zone of the subnet
availabilityZoneId string The AZ ID of the subnet
availableIpAddressCount integer The number of unused private IPv4 addresses in the subnet
defaultForAz boolean Indicates whether this is the default subnet for the Availability Zone
mapPublicIpOnLaunch boolean Indicates whether instances launched in this subnet receive a public IPv4 address
ownerId string The ID of the AWS account that owns the subnet
tags array Any tags assigned to the subnet
View JSON Schema on GitHub

JSON Schema

amazon-vpc-subnet-schema.json Raw ↑
{
  "type": "object",
  "description": "Describes a subnet",
  "properties": {
    "subnetId": {
      "type": "string",
      "description": "The ID of the subnet"
    },
    "subnetArn": {
      "type": "string",
      "description": "The Amazon Resource Name (ARN) of the subnet"
    },
    "vpcId": {
      "type": "string",
      "description": "The ID of the VPC the subnet is in"
    },
    "state": {
      "type": "string",
      "description": "The current state of the subnet",
      "enum": [
        "pending",
        "available"
      ]
    },
    "cidrBlock": {
      "type": "string",
      "description": "The IPv4 CIDR block assigned to the subnet"
    },
    "availabilityZone": {
      "type": "string",
      "description": "The Availability Zone of the subnet"
    },
    "availabilityZoneId": {
      "type": "string",
      "description": "The AZ ID of the subnet"
    },
    "availableIpAddressCount": {
      "type": "integer",
      "description": "The number of unused private IPv4 addresses in the subnet"
    },
    "defaultForAz": {
      "type": "boolean",
      "description": "Indicates whether this is the default subnet for the Availability Zone"
    },
    "mapPublicIpOnLaunch": {
      "type": "boolean",
      "description": "Indicates whether instances launched in this subnet receive a public IPv4 address"
    },
    "ownerId": {
      "type": "string",
      "description": "The ID of the AWS account that owns the subnet"
    },
    "tags": {
      "type": "array",
      "description": "Any tags assigned to the subnet",
      "items": {
        "$ref": "#/components/schemas/Tag"
      }
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Subnet"
}