/** * Network Monitoring API * Use the Network Monitoring API to troubleshoot routing and security issues for resources such as virtual cloud networks (VCNs) and compute instances. For more information, see the console documentation for the [Network Path Analyzer](https://docs.oracle.com/iaas/Content/Network/Concepts/path_analyzer.htm) tool. * OpenAPI spec version: 20160918 * * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ /** * A virtual cloud network (VCN). For more information, see * [Overview of the Networking Service](https://docs.oracle.com/iaas/Content/Network/Concepts/overview.htm). *
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, * talk to an administrator. If you're an administrator who needs to write policies to give users access, see * [Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm). * */ export interface Vcn { /** * The CIDR block IP address of the VCN. *
Example: {@code 172.16.0.0/16} * */ "cidrBlock": string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the VCN. */ "compartmentId": string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the VCN's default set of DHCP options. * */ "defaultDhcpOptionsId"?: string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the VCN's default route table. */ "defaultRouteTableId"?: string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the VCN's default security list. */ "defaultSecurityListId"?: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. * Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}} * */ "definedTags"?: { [key: string]: { [key: string]: any; }; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. * Avoid entering confidential information. * */ "displayName"?: string; /** * A DNS label for the VCN, used in conjunction with the VNIC's hostname and * subnet's DNS label to form a fully qualified domain name (FQDN) for each VNIC * within this subnet (for example, {@code bminstance1.subnet123.vcn1.oraclevcn.com}). * Must be an alphanumeric string that begins with a letter. * The value cannot be changed. *
The absence of this parameter means the Internet and VCN Resolver will * not work for this VCN. *
For more information, see * [DNS in Your Virtual Cloud Network](https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm). *
Example: {@code vcn1} * */ "dnsLabel"?: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. * Example: {@code {\"bar-key\": \"value\"}} * */ "freeformTags"?: { [key: string]: string; }; /** * The VCN's Oracle ID ([OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). */ "id": string; /** * For an IPv6-enabled VCN, this is the IPv6 prefix for the VCN's private IP address space. * The VCN size is always /56. Oracle * provides the IPv6 prefix to use as the *same* CIDR for the {@code ipv6PublicCidrBlock}. * When creating a subnet, specify the last 8 bits, 00 to FF. * See [IPv6 Addresses](https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm). * Example: {@code 2001:0db8:0123::/56} * */ "ipv6CidrBlock"?: string; /** * For an IPv6-enabled VCN, this is the IPv6 prefix for the VCN's public IP address space. * The VCN size is always /56. This prefix is always provided by Oracle. If you don't provide a * custom prefix for the {@code ipv6CidrBlock} when creating the VCN, Oracle assigns that value and also * uses it for {@code ipv6PublicCidrBlock}. Oracle uses addresses from this block for the {@code publicIpAddress} * attribute of an {@link Ipv6} that has internet access allowed. *
Example: {@code 2001:0db8:0123::/48} * */ "ipv6PublicCidrBlock"?: string; /** * The VCN's current state. */ "lifecycleState": Vcn.LifecycleState; /** * The date and time the VCN was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). *
Example: {@code 2016-08-25T21:10:29.600Z} * */ "timeCreated"?: Date; /** * The VCN's domain name, which consists of the VCN's DNS label, and the * {@code oraclevcn.com} domain. *
For more information, see * [DNS in Your Virtual Cloud Network](https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm). *
Example: {@code vcn1.oraclevcn.com} * */ "vcnDomainName"?: string; } export declare namespace Vcn { enum LifecycleState { Provisioning = "PROVISIONING", Available = "AVAILABLE", Terminating = "TERMINATING", Terminated = "TERMINATED", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } function getJsonObj(obj: Vcn): object; function getDeserializedJsonObj(obj: Vcn): object; }