1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. getSubnets
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.Core.getSubnets

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

This data source provides the list of Subnets in Oracle Cloud Infrastructure Core service.

Lists the subnets in the specified VCN and the specified compartment. If the VCN ID is not provided, then the list includes the subnets from all VCNs in the specified compartment.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testSubnets = oci.Core.getSubnets({
    compartmentId: compartmentId,
    displayName: subnetDisplayName,
    state: subnetState,
    vcnId: testVcn.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_subnets = oci.Core.get_subnets(compartment_id=compartment_id,
    display_name=subnet_display_name,
    state=subnet_state,
    vcn_id=test_vcn["id"])
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := core.GetSubnets(ctx, &core.GetSubnetsArgs{
			CompartmentId: compartmentId,
			DisplayName:   pulumi.StringRef(subnetDisplayName),
			State:         pulumi.StringRef(subnetState),
			VcnId:         pulumi.StringRef(testVcn.Id),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testSubnets = Oci.Core.GetSubnets.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = subnetDisplayName,
        State = subnetState,
        VcnId = testVcn.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.CoreFunctions;
import com.pulumi.oci.Core.inputs.GetSubnetsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testSubnets = CoreFunctions.getSubnets(GetSubnetsArgs.builder()
            .compartmentId(compartmentId)
            .displayName(subnetDisplayName)
            .state(subnetState)
            .vcnId(testVcn.id())
            .build());

    }
}
Copy
variables:
  testSubnets:
    fn::invoke:
      function: oci:Core:getSubnets
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${subnetDisplayName}
        state: ${subnetState}
        vcnId: ${testVcn.id}
Copy

Using getSubnets

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getSubnets(args: GetSubnetsArgs, opts?: InvokeOptions): Promise<GetSubnetsResult>
function getSubnetsOutput(args: GetSubnetsOutputArgs, opts?: InvokeOptions): Output<GetSubnetsResult>
Copy
def get_subnets(compartment_id: Optional[str] = None,
                display_name: Optional[str] = None,
                filters: Optional[Sequence[_core.GetSubnetsFilter]] = None,
                state: Optional[str] = None,
                vcn_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetSubnetsResult
def get_subnets_output(compartment_id: Optional[pulumi.Input[str]] = None,
                display_name: Optional[pulumi.Input[str]] = None,
                filters: Optional[pulumi.Input[Sequence[pulumi.Input[_core.GetSubnetsFilterArgs]]]] = None,
                state: Optional[pulumi.Input[str]] = None,
                vcn_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetSubnetsResult]
Copy
func GetSubnets(ctx *Context, args *GetSubnetsArgs, opts ...InvokeOption) (*GetSubnetsResult, error)
func GetSubnetsOutput(ctx *Context, args *GetSubnetsOutputArgs, opts ...InvokeOption) GetSubnetsResultOutput
Copy

> Note: This function is named GetSubnets in the Go SDK.

public static class GetSubnets 
{
    public static Task<GetSubnetsResult> InvokeAsync(GetSubnetsArgs args, InvokeOptions? opts = null)
    public static Output<GetSubnetsResult> Invoke(GetSubnetsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSubnetsResult> getSubnets(GetSubnetsArgs args, InvokeOptions options)
public static Output<GetSubnetsResult> getSubnets(GetSubnetsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Core/getSubnets:getSubnets
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CompartmentId This property is required. string
The OCID of the compartment.
DisplayName string
A filter to return only resources that match the given display name exactly.
Filters Changes to this property will trigger replacement. List<GetSubnetsFilter>
State string
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
VcnId string
The OCID of the VCN.
CompartmentId This property is required. string
The OCID of the compartment.
DisplayName string
A filter to return only resources that match the given display name exactly.
Filters Changes to this property will trigger replacement. []GetSubnetsFilter
State string
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
VcnId string
The OCID of the VCN.
compartmentId This property is required. String
The OCID of the compartment.
displayName String
A filter to return only resources that match the given display name exactly.
filters Changes to this property will trigger replacement. List<GetSubnetsFilter>
state String
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
vcnId String
The OCID of the VCN.
compartmentId This property is required. string
The OCID of the compartment.
displayName string
A filter to return only resources that match the given display name exactly.
filters Changes to this property will trigger replacement. GetSubnetsFilter[]
state string
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
vcnId string
The OCID of the VCN.
compartment_id This property is required. str
The OCID of the compartment.
display_name str
A filter to return only resources that match the given display name exactly.
filters Changes to this property will trigger replacement. Sequence[core.GetSubnetsFilter]
state str
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
vcn_id str
The OCID of the VCN.
compartmentId This property is required. String
The OCID of the compartment.
displayName String
A filter to return only resources that match the given display name exactly.
filters Changes to this property will trigger replacement. List<Property Map>
state String
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
vcnId String
The OCID of the VCN.

getSubnets Result

The following output properties are available:

CompartmentId string
The OCID of the compartment containing the subnet.
Id string
The provider-assigned unique ID for this managed resource.
Subnets List<GetSubnetsSubnet>
The list of subnets.
DisplayName string
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Filters List<GetSubnetsFilter>
State string
The subnet's current state.
VcnId string
The OCID of the VCN the subnet is in.
CompartmentId string
The OCID of the compartment containing the subnet.
Id string
The provider-assigned unique ID for this managed resource.
Subnets []GetSubnetsSubnet
The list of subnets.
DisplayName string
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Filters []GetSubnetsFilter
State string
The subnet's current state.
VcnId string
The OCID of the VCN the subnet is in.
compartmentId String
The OCID of the compartment containing the subnet.
id String
The provider-assigned unique ID for this managed resource.
subnets List<GetSubnetsSubnet>
The list of subnets.
displayName String
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters List<GetSubnetsFilter>
state String
The subnet's current state.
vcnId String
The OCID of the VCN the subnet is in.
compartmentId string
The OCID of the compartment containing the subnet.
id string
The provider-assigned unique ID for this managed resource.
subnets GetSubnetsSubnet[]
The list of subnets.
displayName string
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters GetSubnetsFilter[]
state string
The subnet's current state.
vcnId string
The OCID of the VCN the subnet is in.
compartment_id str
The OCID of the compartment containing the subnet.
id str
The provider-assigned unique ID for this managed resource.
subnets Sequence[core.GetSubnetsSubnet]
The list of subnets.
display_name str
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters Sequence[core.GetSubnetsFilter]
state str
The subnet's current state.
vcn_id str
The OCID of the VCN the subnet is in.
compartmentId String
The OCID of the compartment containing the subnet.
id String
The provider-assigned unique ID for this managed resource.
subnets List<Property Map>
The list of subnets.
displayName String
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters List<Property Map>
state String
The subnet's current state.
vcnId String
The OCID of the VCN the subnet is in.

Supporting Types

GetSubnetsFilter

Name This property is required. string
Values This property is required. List<string>
Regex bool
Name This property is required. string
Values This property is required. []string
Regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean
name This property is required. string
values This property is required. string[]
regex boolean
name This property is required. str
values This property is required. Sequence[str]
regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean

GetSubnetsSubnet

AvailabilityDomain This property is required. string
The subnet's availability domain. This attribute will be null if this is a regional subnet instead of an AD-specific subnet. Oracle recommends creating regional subnets. Example: Uocm:PHX-AD-1
CidrBlock This property is required. string
The subnet's CIDR block. Example: 10.0.1.0/24
CompartmentId This property is required. string
The OCID of the compartment.
DefinedTags This property is required. Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DhcpOptionsId This property is required. string
The OCID of the set of DHCP options that the subnet uses.
DisplayName This property is required. string
A filter to return only resources that match the given display name exactly.
DnsLabel This property is required. string
A DNS label for the subnet, used in conjunction with the VNIC's hostname and VCN's DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, bminstance1.subnet123.vcn1.oraclevcn.com). Must be an alphanumeric string that begins with a letter and is unique within the VCN. The value cannot be changed.
FreeformTags This property is required. Dictionary<string, string>
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: {"Department": "Finance"}
Id This property is required. string
The subnet's Oracle ID (OCID).
Ipv6cidrBlock This property is required. string
For an IPv6-enabled subnet, this is the IPv6 prefix for the subnet's IP address space. The subnet size is always /64. See IPv6 Addresses. Example: 2001:0db8:0123:1111::/64
Ipv6cidrBlocks This property is required. List<string>
The list of all IPv6 prefixes (Oracle allocated IPv6 GUA, ULA or private IPv6 prefixes, BYOIPv6 prefixes) for the subnet.
Ipv6virtualRouterIp This property is required. string
For an IPv6-enabled subnet, this is the IPv6 address of the virtual router. Example: 2001:0db8:0123:1111:89ab:cdef:1234:5678
ProhibitInternetIngress This property is required. bool
Whether to disallow ingress internet traffic to VNICs within this subnet. Defaults to false.
ProhibitPublicIpOnVnic This property is required. bool
Whether VNICs within this subnet can have public IP addresses. Defaults to false, which means VNICs created in this subnet will automatically be assigned public IP addresses unless specified otherwise during instance launch or VNIC creation (with the assignPublicIp flag in CreateVnicDetails). If prohibitPublicIpOnVnic is set to true, VNICs created in this subnet cannot have public IP addresses (that is, it's a private subnet). Example: true
RouteTableId This property is required. string
The OCID of the route table that the subnet uses.
SecurityListIds This property is required. List<string>
The OCIDs of the security list or lists that the subnet uses. Remember that security lists are associated with the subnet, but the rules are applied to the individual VNICs in the subnet.
State This property is required. string
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
SubnetDomainName This property is required. string
The subnet's domain name, which consists of the subnet's DNS label, the VCN's DNS label, and the oraclevcn.com domain.
TimeCreated This property is required. string
The date and time the subnet was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
VcnId This property is required. string
The OCID of the VCN.
VirtualRouterIp This property is required. string
The IP address of the virtual router. Example: 10.0.14.1
VirtualRouterMac This property is required. string
The MAC address of the virtual router. Example: 00:00:00:00:00:01
AvailabilityDomain This property is required. string
The subnet's availability domain. This attribute will be null if this is a regional subnet instead of an AD-specific subnet. Oracle recommends creating regional subnets. Example: Uocm:PHX-AD-1
CidrBlock This property is required. string
The subnet's CIDR block. Example: 10.0.1.0/24
CompartmentId This property is required. string
The OCID of the compartment.
DefinedTags This property is required. map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DhcpOptionsId This property is required. string
The OCID of the set of DHCP options that the subnet uses.
DisplayName This property is required. string
A filter to return only resources that match the given display name exactly.
DnsLabel This property is required. string
A DNS label for the subnet, used in conjunction with the VNIC's hostname and VCN's DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, bminstance1.subnet123.vcn1.oraclevcn.com). Must be an alphanumeric string that begins with a letter and is unique within the VCN. The value cannot be changed.
FreeformTags This property is required. map[string]string
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: {"Department": "Finance"}
Id This property is required. string
The subnet's Oracle ID (OCID).
Ipv6cidrBlock This property is required. string
For an IPv6-enabled subnet, this is the IPv6 prefix for the subnet's IP address space. The subnet size is always /64. See IPv6 Addresses. Example: 2001:0db8:0123:1111::/64
Ipv6cidrBlocks This property is required. []string
The list of all IPv6 prefixes (Oracle allocated IPv6 GUA, ULA or private IPv6 prefixes, BYOIPv6 prefixes) for the subnet.
Ipv6virtualRouterIp This property is required. string
For an IPv6-enabled subnet, this is the IPv6 address of the virtual router. Example: 2001:0db8:0123:1111:89ab:cdef:1234:5678
ProhibitInternetIngress This property is required. bool
Whether to disallow ingress internet traffic to VNICs within this subnet. Defaults to false.
ProhibitPublicIpOnVnic This property is required. bool
Whether VNICs within this subnet can have public IP addresses. Defaults to false, which means VNICs created in this subnet will automatically be assigned public IP addresses unless specified otherwise during instance launch or VNIC creation (with the assignPublicIp flag in CreateVnicDetails). If prohibitPublicIpOnVnic is set to true, VNICs created in this subnet cannot have public IP addresses (that is, it's a private subnet). Example: true
RouteTableId This property is required. string
The OCID of the route table that the subnet uses.
SecurityListIds This property is required. []string
The OCIDs of the security list or lists that the subnet uses. Remember that security lists are associated with the subnet, but the rules are applied to the individual VNICs in the subnet.
State This property is required. string
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
SubnetDomainName This property is required. string
The subnet's domain name, which consists of the subnet's DNS label, the VCN's DNS label, and the oraclevcn.com domain.
TimeCreated This property is required. string
The date and time the subnet was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
VcnId This property is required. string
The OCID of the VCN.
VirtualRouterIp This property is required. string
The IP address of the virtual router. Example: 10.0.14.1
VirtualRouterMac This property is required. string
The MAC address of the virtual router. Example: 00:00:00:00:00:01
availabilityDomain This property is required. String
The subnet's availability domain. This attribute will be null if this is a regional subnet instead of an AD-specific subnet. Oracle recommends creating regional subnets. Example: Uocm:PHX-AD-1
cidrBlock This property is required. String
The subnet's CIDR block. Example: 10.0.1.0/24
compartmentId This property is required. String
The OCID of the compartment.
definedTags This property is required. Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
dhcpOptionsId This property is required. String
The OCID of the set of DHCP options that the subnet uses.
displayName This property is required. String
A filter to return only resources that match the given display name exactly.
dnsLabel This property is required. String
A DNS label for the subnet, used in conjunction with the VNIC's hostname and VCN's DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, bminstance1.subnet123.vcn1.oraclevcn.com). Must be an alphanumeric string that begins with a letter and is unique within the VCN. The value cannot be changed.
freeformTags This property is required. Map<String,String>
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: {"Department": "Finance"}
id This property is required. String
The subnet's Oracle ID (OCID).
ipv6cidrBlock This property is required. String
For an IPv6-enabled subnet, this is the IPv6 prefix for the subnet's IP address space. The subnet size is always /64. See IPv6 Addresses. Example: 2001:0db8:0123:1111::/64
ipv6cidrBlocks This property is required. List<String>
The list of all IPv6 prefixes (Oracle allocated IPv6 GUA, ULA or private IPv6 prefixes, BYOIPv6 prefixes) for the subnet.
ipv6virtualRouterIp This property is required. String
For an IPv6-enabled subnet, this is the IPv6 address of the virtual router. Example: 2001:0db8:0123:1111:89ab:cdef:1234:5678
prohibitInternetIngress This property is required. Boolean
Whether to disallow ingress internet traffic to VNICs within this subnet. Defaults to false.
prohibitPublicIpOnVnic This property is required. Boolean
Whether VNICs within this subnet can have public IP addresses. Defaults to false, which means VNICs created in this subnet will automatically be assigned public IP addresses unless specified otherwise during instance launch or VNIC creation (with the assignPublicIp flag in CreateVnicDetails). If prohibitPublicIpOnVnic is set to true, VNICs created in this subnet cannot have public IP addresses (that is, it's a private subnet). Example: true
routeTableId This property is required. String
The OCID of the route table that the subnet uses.
securityListIds This property is required. List<String>
The OCIDs of the security list or lists that the subnet uses. Remember that security lists are associated with the subnet, but the rules are applied to the individual VNICs in the subnet.
state This property is required. String
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
subnetDomainName This property is required. String
The subnet's domain name, which consists of the subnet's DNS label, the VCN's DNS label, and the oraclevcn.com domain.
timeCreated This property is required. String
The date and time the subnet was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
vcnId This property is required. String
The OCID of the VCN.
virtualRouterIp This property is required. String
The IP address of the virtual router. Example: 10.0.14.1
virtualRouterMac This property is required. String
The MAC address of the virtual router. Example: 00:00:00:00:00:01
availabilityDomain This property is required. string
The subnet's availability domain. This attribute will be null if this is a regional subnet instead of an AD-specific subnet. Oracle recommends creating regional subnets. Example: Uocm:PHX-AD-1
cidrBlock This property is required. string
The subnet's CIDR block. Example: 10.0.1.0/24
compartmentId This property is required. string
The OCID of the compartment.
definedTags This property is required. {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
dhcpOptionsId This property is required. string
The OCID of the set of DHCP options that the subnet uses.
displayName This property is required. string
A filter to return only resources that match the given display name exactly.
dnsLabel This property is required. string
A DNS label for the subnet, used in conjunction with the VNIC's hostname and VCN's DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, bminstance1.subnet123.vcn1.oraclevcn.com). Must be an alphanumeric string that begins with a letter and is unique within the VCN. The value cannot be changed.
freeformTags This property is required. {[key: string]: string}
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: {"Department": "Finance"}
id This property is required. string
The subnet's Oracle ID (OCID).
ipv6cidrBlock This property is required. string
For an IPv6-enabled subnet, this is the IPv6 prefix for the subnet's IP address space. The subnet size is always /64. See IPv6 Addresses. Example: 2001:0db8:0123:1111::/64
ipv6cidrBlocks This property is required. string[]
The list of all IPv6 prefixes (Oracle allocated IPv6 GUA, ULA or private IPv6 prefixes, BYOIPv6 prefixes) for the subnet.
ipv6virtualRouterIp This property is required. string
For an IPv6-enabled subnet, this is the IPv6 address of the virtual router. Example: 2001:0db8:0123:1111:89ab:cdef:1234:5678
prohibitInternetIngress This property is required. boolean
Whether to disallow ingress internet traffic to VNICs within this subnet. Defaults to false.
prohibitPublicIpOnVnic This property is required. boolean
Whether VNICs within this subnet can have public IP addresses. Defaults to false, which means VNICs created in this subnet will automatically be assigned public IP addresses unless specified otherwise during instance launch or VNIC creation (with the assignPublicIp flag in CreateVnicDetails). If prohibitPublicIpOnVnic is set to true, VNICs created in this subnet cannot have public IP addresses (that is, it's a private subnet). Example: true
routeTableId This property is required. string
The OCID of the route table that the subnet uses.
securityListIds This property is required. string[]
The OCIDs of the security list or lists that the subnet uses. Remember that security lists are associated with the subnet, but the rules are applied to the individual VNICs in the subnet.
state This property is required. string
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
subnetDomainName This property is required. string
The subnet's domain name, which consists of the subnet's DNS label, the VCN's DNS label, and the oraclevcn.com domain.
timeCreated This property is required. string
The date and time the subnet was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
vcnId This property is required. string
The OCID of the VCN.
virtualRouterIp This property is required. string
The IP address of the virtual router. Example: 10.0.14.1
virtualRouterMac This property is required. string
The MAC address of the virtual router. Example: 00:00:00:00:00:01
availability_domain This property is required. str
The subnet's availability domain. This attribute will be null if this is a regional subnet instead of an AD-specific subnet. Oracle recommends creating regional subnets. Example: Uocm:PHX-AD-1
cidr_block This property is required. str
The subnet's CIDR block. Example: 10.0.1.0/24
compartment_id This property is required. str
The OCID of the compartment.
defined_tags This property is required. Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
dhcp_options_id This property is required. str
The OCID of the set of DHCP options that the subnet uses.
display_name This property is required. str
A filter to return only resources that match the given display name exactly.
dns_label This property is required. str
A DNS label for the subnet, used in conjunction with the VNIC's hostname and VCN's DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, bminstance1.subnet123.vcn1.oraclevcn.com). Must be an alphanumeric string that begins with a letter and is unique within the VCN. The value cannot be changed.
freeform_tags This property is required. Mapping[str, str]
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: {"Department": "Finance"}
id This property is required. str
The subnet's Oracle ID (OCID).
ipv6cidr_block This property is required. str
For an IPv6-enabled subnet, this is the IPv6 prefix for the subnet's IP address space. The subnet size is always /64. See IPv6 Addresses. Example: 2001:0db8:0123:1111::/64
ipv6cidr_blocks This property is required. Sequence[str]
The list of all IPv6 prefixes (Oracle allocated IPv6 GUA, ULA or private IPv6 prefixes, BYOIPv6 prefixes) for the subnet.
ipv6virtual_router_ip This property is required. str
For an IPv6-enabled subnet, this is the IPv6 address of the virtual router. Example: 2001:0db8:0123:1111:89ab:cdef:1234:5678
prohibit_internet_ingress This property is required. bool
Whether to disallow ingress internet traffic to VNICs within this subnet. Defaults to false.
prohibit_public_ip_on_vnic This property is required. bool
Whether VNICs within this subnet can have public IP addresses. Defaults to false, which means VNICs created in this subnet will automatically be assigned public IP addresses unless specified otherwise during instance launch or VNIC creation (with the assignPublicIp flag in CreateVnicDetails). If prohibitPublicIpOnVnic is set to true, VNICs created in this subnet cannot have public IP addresses (that is, it's a private subnet). Example: true
route_table_id This property is required. str
The OCID of the route table that the subnet uses.
security_list_ids This property is required. Sequence[str]
The OCIDs of the security list or lists that the subnet uses. Remember that security lists are associated with the subnet, but the rules are applied to the individual VNICs in the subnet.
state This property is required. str
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
subnet_domain_name This property is required. str
The subnet's domain name, which consists of the subnet's DNS label, the VCN's DNS label, and the oraclevcn.com domain.
time_created This property is required. str
The date and time the subnet was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
vcn_id This property is required. str
The OCID of the VCN.
virtual_router_ip This property is required. str
The IP address of the virtual router. Example: 10.0.14.1
virtual_router_mac This property is required. str
The MAC address of the virtual router. Example: 00:00:00:00:00:01
availabilityDomain This property is required. String
The subnet's availability domain. This attribute will be null if this is a regional subnet instead of an AD-specific subnet. Oracle recommends creating regional subnets. Example: Uocm:PHX-AD-1
cidrBlock This property is required. String
The subnet's CIDR block. Example: 10.0.1.0/24
compartmentId This property is required. String
The OCID of the compartment.
definedTags This property is required. Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
dhcpOptionsId This property is required. String
The OCID of the set of DHCP options that the subnet uses.
displayName This property is required. String
A filter to return only resources that match the given display name exactly.
dnsLabel This property is required. String
A DNS label for the subnet, used in conjunction with the VNIC's hostname and VCN's DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, bminstance1.subnet123.vcn1.oraclevcn.com). Must be an alphanumeric string that begins with a letter and is unique within the VCN. The value cannot be changed.
freeformTags This property is required. Map<String>
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: {"Department": "Finance"}
id This property is required. String
The subnet's Oracle ID (OCID).
ipv6cidrBlock This property is required. String
For an IPv6-enabled subnet, this is the IPv6 prefix for the subnet's IP address space. The subnet size is always /64. See IPv6 Addresses. Example: 2001:0db8:0123:1111::/64
ipv6cidrBlocks This property is required. List<String>
The list of all IPv6 prefixes (Oracle allocated IPv6 GUA, ULA or private IPv6 prefixes, BYOIPv6 prefixes) for the subnet.
ipv6virtualRouterIp This property is required. String
For an IPv6-enabled subnet, this is the IPv6 address of the virtual router. Example: 2001:0db8:0123:1111:89ab:cdef:1234:5678
prohibitInternetIngress This property is required. Boolean
Whether to disallow ingress internet traffic to VNICs within this subnet. Defaults to false.
prohibitPublicIpOnVnic This property is required. Boolean
Whether VNICs within this subnet can have public IP addresses. Defaults to false, which means VNICs created in this subnet will automatically be assigned public IP addresses unless specified otherwise during instance launch or VNIC creation (with the assignPublicIp flag in CreateVnicDetails). If prohibitPublicIpOnVnic is set to true, VNICs created in this subnet cannot have public IP addresses (that is, it's a private subnet). Example: true
routeTableId This property is required. String
The OCID of the route table that the subnet uses.
securityListIds This property is required. List<String>
The OCIDs of the security list or lists that the subnet uses. Remember that security lists are associated with the subnet, but the rules are applied to the individual VNICs in the subnet.
state This property is required. String
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
subnetDomainName This property is required. String
The subnet's domain name, which consists of the subnet's DNS label, the VCN's DNS label, and the oraclevcn.com domain.
timeCreated This property is required. String
The date and time the subnet was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
vcnId This property is required. String
The OCID of the VCN.
virtualRouterIp This property is required. String
The IP address of the virtual router. Example: 10.0.14.1
virtualRouterMac This property is required. String
The MAC address of the virtual router. Example: 00:00:00:00:00:01

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi