Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Vcn

A virtual cloud network (VCN). For more information, see Overview of the Networking Service.

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.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).

Properties

Optional byoipv6CidrBlocks

byoipv6CidrBlocks: Array<string>

The list of BYOIPv6 prefixes required to create a VCN that uses BYOIPv6 ranges.

cidrBlock

cidrBlock: string

Deprecated. The first CIDR IP address from cidrBlocks.

Example: {@code 172.16.0.0/16}

cidrBlocks

cidrBlocks: Array<string>

The list of IPv4 CIDR blocks the VCN will use.

compartmentId

compartmentId: string

The OCID of the compartment containing the VCN.

Optional defaultDhcpOptionsId

defaultDhcpOptionsId: undefined | string

The OCID for the VCN's default set of DHCP options.

Optional defaultRouteTableId

defaultRouteTableId: undefined | string

The OCID for the VCN's default route table.

Optional defaultSecurityListId

defaultSecurityListId: undefined | string

The OCID for the VCN's default security list.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional displayName

displayName: undefined | string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Optional dnsLabel

dnsLabel: undefined | 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.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).

Example: {@code vcn1}

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {@code {\"Department\": \"Finance\"}}

id

id: string

The VCN's Oracle ID (OCID).

Optional ipv6CidrBlocks

ipv6CidrBlocks: Array<string>

For an IPv6-enabled VCN, this is the list of IPv6 prefixes for the VCN's IP address space. The prefixes are provided by Oracle and the sizes are always /56.

Optional ipv6PrivateCidrBlocks

ipv6PrivateCidrBlocks: Array<string>

For an IPv6-enabled VCN, this is the list of Private IPv6 prefixes for the VCN's IP address space.

lifecycleState

lifecycleState: LifecycleState

The VCN's current state.

Optional timeCreated

timeCreated: Date

The date and time the VCN was created, in the format defined by RFC3339.

Example: {@code 2016-08-25T21:10:29.600Z}

Optional vcnDomainName

vcnDomainName: undefined | string

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.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).

Example: {@code vcn1.oraclevcn.com}

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Vcn): object

getJsonObj

  • getJsonObj(obj: Vcn): object