1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. NatGateway
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

oci.Core.NatGateway

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

    This resource provides the Nat Gateway resource in Oracle Cloud Infrastructure Core service.

    Creates a new NAT gateway for the specified VCN. You must also set up a route rule with the NAT gateway as the rule’s target. See Route Table.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testNatGateway = new oci.core.NatGateway("testNatGateway", {
        compartmentId: _var.compartment_id,
        vcnId: oci_core_vcn.test_vcn.id,
        blockTraffic: _var.nat_gateway_block_traffic,
        definedTags: {
            "Operations.CostCenter": "42",
        },
        displayName: _var.nat_gateway_display_name,
        freeformTags: {
            Department: "Finance",
        },
        publicIpId: oci_core_public_ip.test_public_ip.id,
        routeTableId: oci_core_route_table.test_route_table.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_nat_gateway = oci.core.NatGateway("testNatGateway",
        compartment_id=var["compartment_id"],
        vcn_id=oci_core_vcn["test_vcn"]["id"],
        block_traffic=var["nat_gateway_block_traffic"],
        defined_tags={
            "Operations.CostCenter": "42",
        },
        display_name=var["nat_gateway_display_name"],
        freeform_tags={
            "Department": "Finance",
        },
        public_ip_id=oci_core_public_ip["test_public_ip"]["id"],
        route_table_id=oci_core_route_table["test_route_table"]["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/Core"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Core.NewNatGateway(ctx, "testNatGateway", &Core.NatGatewayArgs{
    			CompartmentId: pulumi.Any(_var.Compartment_id),
    			VcnId:         pulumi.Any(oci_core_vcn.Test_vcn.Id),
    			BlockTraffic:  pulumi.Any(_var.Nat_gateway_block_traffic),
    			DefinedTags: pulumi.Map{
    				"Operations.CostCenter": pulumi.Any("42"),
    			},
    			DisplayName: pulumi.Any(_var.Nat_gateway_display_name),
    			FreeformTags: pulumi.Map{
    				"Department": pulumi.Any("Finance"),
    			},
    			PublicIpId:   pulumi.Any(oci_core_public_ip.Test_public_ip.Id),
    			RouteTableId: pulumi.Any(oci_core_route_table.Test_route_table.Id),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testNatGateway = new Oci.Core.NatGateway("testNatGateway", new()
        {
            CompartmentId = @var.Compartment_id,
            VcnId = oci_core_vcn.Test_vcn.Id,
            BlockTraffic = @var.Nat_gateway_block_traffic,
            DefinedTags = 
            {
                { "Operations.CostCenter", "42" },
            },
            DisplayName = @var.Nat_gateway_display_name,
            FreeformTags = 
            {
                { "Department", "Finance" },
            },
            PublicIpId = oci_core_public_ip.Test_public_ip.Id,
            RouteTableId = oci_core_route_table.Test_route_table.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Core.NatGateway;
    import com.pulumi.oci.Core.NatGatewayArgs;
    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) {
            var testNatGateway = new NatGateway("testNatGateway", NatGatewayArgs.builder()        
                .compartmentId(var_.compartment_id())
                .vcnId(oci_core_vcn.test_vcn().id())
                .blockTraffic(var_.nat_gateway_block_traffic())
                .definedTags(Map.of("Operations.CostCenter", "42"))
                .displayName(var_.nat_gateway_display_name())
                .freeformTags(Map.of("Department", "Finance"))
                .publicIpId(oci_core_public_ip.test_public_ip().id())
                .routeTableId(oci_core_route_table.test_route_table().id())
                .build());
    
        }
    }
    
    resources:
      testNatGateway:
        type: oci:Core:NatGateway
        properties:
          #Required
          compartmentId: ${var.compartment_id}
          vcnId: ${oci_core_vcn.test_vcn.id}
          #Optional
          blockTraffic: ${var.nat_gateway_block_traffic}
          definedTags:
            Operations.CostCenter: '42'
          displayName: ${var.nat_gateway_display_name}
          freeformTags:
            Department: Finance
          publicIpId: ${oci_core_public_ip.test_public_ip.id}
          routeTableId: ${oci_core_route_table.test_route_table.id}
    

    Create NatGateway Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new NatGateway(name: string, args: NatGatewayArgs, opts?: CustomResourceOptions);
    @overload
    def NatGateway(resource_name: str,
                   args: NatGatewayArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def NatGateway(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   compartment_id: Optional[str] = None,
                   vcn_id: Optional[str] = None,
                   block_traffic: Optional[bool] = None,
                   defined_tags: Optional[Mapping[str, Any]] = None,
                   display_name: Optional[str] = None,
                   freeform_tags: Optional[Mapping[str, Any]] = None,
                   public_ip_id: Optional[str] = None,
                   route_table_id: Optional[str] = None)
    func NewNatGateway(ctx *Context, name string, args NatGatewayArgs, opts ...ResourceOption) (*NatGateway, error)
    public NatGateway(string name, NatGatewayArgs args, CustomResourceOptions? opts = null)
    public NatGateway(String name, NatGatewayArgs args)
    public NatGateway(String name, NatGatewayArgs args, CustomResourceOptions options)
    
    type: oci:Core:NatGateway
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args NatGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args NatGatewayArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args NatGatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NatGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NatGatewayArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var natGatewayResource = new Oci.Core.NatGateway("natGatewayResource", new()
    {
        CompartmentId = "string",
        VcnId = "string",
        BlockTraffic = false,
        DefinedTags = 
        {
            { "string", "any" },
        },
        DisplayName = "string",
        FreeformTags = 
        {
            { "string", "any" },
        },
        PublicIpId = "string",
        RouteTableId = "string",
    });
    
    example, err := Core.NewNatGateway(ctx, "natGatewayResource", &Core.NatGatewayArgs{
    	CompartmentId: pulumi.String("string"),
    	VcnId:         pulumi.String("string"),
    	BlockTraffic:  pulumi.Bool(false),
    	DefinedTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	DisplayName: pulumi.String("string"),
    	FreeformTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	PublicIpId:   pulumi.String("string"),
    	RouteTableId: pulumi.String("string"),
    })
    
    var natGatewayResource = new NatGateway("natGatewayResource", NatGatewayArgs.builder()        
        .compartmentId("string")
        .vcnId("string")
        .blockTraffic(false)
        .definedTags(Map.of("string", "any"))
        .displayName("string")
        .freeformTags(Map.of("string", "any"))
        .publicIpId("string")
        .routeTableId("string")
        .build());
    
    nat_gateway_resource = oci.core.NatGateway("natGatewayResource",
        compartment_id="string",
        vcn_id="string",
        block_traffic=False,
        defined_tags={
            "string": "any",
        },
        display_name="string",
        freeform_tags={
            "string": "any",
        },
        public_ip_id="string",
        route_table_id="string")
    
    const natGatewayResource = new oci.core.NatGateway("natGatewayResource", {
        compartmentId: "string",
        vcnId: "string",
        blockTraffic: false,
        definedTags: {
            string: "any",
        },
        displayName: "string",
        freeformTags: {
            string: "any",
        },
        publicIpId: "string",
        routeTableId: "string",
    });
    
    type: oci:Core:NatGateway
    properties:
        blockTraffic: false
        compartmentId: string
        definedTags:
            string: any
        displayName: string
        freeformTags:
            string: any
        publicIpId: string
        routeTableId: string
        vcnId: string
    

    NatGateway Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The NatGateway resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of the compartment to contain the NAT gateway.
    VcnId string

    The OCID of the VCN the gateway belongs to.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    BlockTraffic bool
    (Updatable) Whether the NAT gateway blocks traffic through it. The default is false. Example: true
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags Dictionary<string, object>
    (Updatable) 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"}
    PublicIpId string
    The OCID of the public IP address associated with the NAT gateway.
    RouteTableId string

    (Updatable) The OCID of the route table used by the NAT gateway.

    If you don't specify a route table here, the NAT gateway is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the NAT gateway.

    CompartmentId string
    (Updatable) The OCID of the compartment to contain the NAT gateway.
    VcnId string

    The OCID of the VCN the gateway belongs to.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    BlockTraffic bool
    (Updatable) Whether the NAT gateway blocks traffic through it. The default is false. Example: true
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags map[string]interface{}
    (Updatable) 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"}
    PublicIpId string
    The OCID of the public IP address associated with the NAT gateway.
    RouteTableId string

    (Updatable) The OCID of the route table used by the NAT gateway.

    If you don't specify a route table here, the NAT gateway is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the NAT gateway.

    compartmentId String
    (Updatable) The OCID of the compartment to contain the NAT gateway.
    vcnId String

    The OCID of the VCN the gateway belongs to.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    blockTraffic Boolean
    (Updatable) Whether the NAT gateway blocks traffic through it. The default is false. Example: true
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String,Object>
    (Updatable) 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"}
    publicIpId String
    The OCID of the public IP address associated with the NAT gateway.
    routeTableId String

    (Updatable) The OCID of the route table used by the NAT gateway.

    If you don't specify a route table here, the NAT gateway is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the NAT gateway.

    compartmentId string
    (Updatable) The OCID of the compartment to contain the NAT gateway.
    vcnId string

    The OCID of the VCN the gateway belongs to.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    blockTraffic boolean
    (Updatable) Whether the NAT gateway blocks traffic through it. The default is false. Example: true
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags {[key: string]: any}
    (Updatable) 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"}
    publicIpId string
    The OCID of the public IP address associated with the NAT gateway.
    routeTableId string

    (Updatable) The OCID of the route table used by the NAT gateway.

    If you don't specify a route table here, the NAT gateway is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the NAT gateway.

    compartment_id str
    (Updatable) The OCID of the compartment to contain the NAT gateway.
    vcn_id str

    The OCID of the VCN the gateway belongs to.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    block_traffic bool
    (Updatable) Whether the NAT gateway blocks traffic through it. The default is false. Example: true
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeform_tags Mapping[str, Any]
    (Updatable) 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"}
    public_ip_id str
    The OCID of the public IP address associated with the NAT gateway.
    route_table_id str

    (Updatable) The OCID of the route table used by the NAT gateway.

    If you don't specify a route table here, the NAT gateway is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the NAT gateway.

    compartmentId String
    (Updatable) The OCID of the compartment to contain the NAT gateway.
    vcnId String

    The OCID of the VCN the gateway belongs to.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    blockTraffic Boolean
    (Updatable) Whether the NAT gateway blocks traffic through it. The default is false. Example: true
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<Any>
    (Updatable) 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"}
    publicIpId String
    The OCID of the public IP address associated with the NAT gateway.
    routeTableId String

    (Updatable) The OCID of the route table used by the NAT gateway.

    If you don't specify a route table here, the NAT gateway is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the NAT gateway.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the NatGateway resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    NatIp string
    The IP address associated with the NAT gateway.
    State string
    The NAT gateway's current state.
    TimeCreated string
    The date and time the NAT gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    Id string
    The provider-assigned unique ID for this managed resource.
    NatIp string
    The IP address associated with the NAT gateway.
    State string
    The NAT gateway's current state.
    TimeCreated string
    The date and time the NAT gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    id String
    The provider-assigned unique ID for this managed resource.
    natIp String
    The IP address associated with the NAT gateway.
    state String
    The NAT gateway's current state.
    timeCreated String
    The date and time the NAT gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    id string
    The provider-assigned unique ID for this managed resource.
    natIp string
    The IP address associated with the NAT gateway.
    state string
    The NAT gateway's current state.
    timeCreated string
    The date and time the NAT gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    id str
    The provider-assigned unique ID for this managed resource.
    nat_ip str
    The IP address associated with the NAT gateway.
    state str
    The NAT gateway's current state.
    time_created str
    The date and time the NAT gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    id String
    The provider-assigned unique ID for this managed resource.
    natIp String
    The IP address associated with the NAT gateway.
    state String
    The NAT gateway's current state.
    timeCreated String
    The date and time the NAT gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

    Look up Existing NatGateway Resource

    Get an existing NatGateway resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: NatGatewayState, opts?: CustomResourceOptions): NatGateway
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            block_traffic: Optional[bool] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            display_name: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            nat_ip: Optional[str] = None,
            public_ip_id: Optional[str] = None,
            route_table_id: Optional[str] = None,
            state: Optional[str] = None,
            time_created: Optional[str] = None,
            vcn_id: Optional[str] = None) -> NatGateway
    func GetNatGateway(ctx *Context, name string, id IDInput, state *NatGatewayState, opts ...ResourceOption) (*NatGateway, error)
    public static NatGateway Get(string name, Input<string> id, NatGatewayState? state, CustomResourceOptions? opts = null)
    public static NatGateway get(String name, Output<String> id, NatGatewayState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    BlockTraffic bool
    (Updatable) Whether the NAT gateway blocks traffic through it. The default is false. Example: true
    CompartmentId string
    (Updatable) The OCID of the compartment to contain the NAT gateway.
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags Dictionary<string, object>
    (Updatable) 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"}
    NatIp string
    The IP address associated with the NAT gateway.
    PublicIpId string
    The OCID of the public IP address associated with the NAT gateway.
    RouteTableId string

    (Updatable) The OCID of the route table used by the NAT gateway.

    If you don't specify a route table here, the NAT gateway is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the NAT gateway.

    State string
    The NAT gateway's current state.
    TimeCreated string
    The date and time the NAT gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    VcnId string

    The OCID of the VCN the gateway belongs to.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    BlockTraffic bool
    (Updatable) Whether the NAT gateway blocks traffic through it. The default is false. Example: true
    CompartmentId string
    (Updatable) The OCID of the compartment to contain the NAT gateway.
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags map[string]interface{}
    (Updatable) 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"}
    NatIp string
    The IP address associated with the NAT gateway.
    PublicIpId string
    The OCID of the public IP address associated with the NAT gateway.
    RouteTableId string

    (Updatable) The OCID of the route table used by the NAT gateway.

    If you don't specify a route table here, the NAT gateway is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the NAT gateway.

    State string
    The NAT gateway's current state.
    TimeCreated string
    The date and time the NAT gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    VcnId string

    The OCID of the VCN the gateway belongs to.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    blockTraffic Boolean
    (Updatable) Whether the NAT gateway blocks traffic through it. The default is false. Example: true
    compartmentId String
    (Updatable) The OCID of the compartment to contain the NAT gateway.
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String,Object>
    (Updatable) 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"}
    natIp String
    The IP address associated with the NAT gateway.
    publicIpId String
    The OCID of the public IP address associated with the NAT gateway.
    routeTableId String

    (Updatable) The OCID of the route table used by the NAT gateway.

    If you don't specify a route table here, the NAT gateway is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the NAT gateway.

    state String
    The NAT gateway's current state.
    timeCreated String
    The date and time the NAT gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    vcnId String

    The OCID of the VCN the gateway belongs to.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    blockTraffic boolean
    (Updatable) Whether the NAT gateway blocks traffic through it. The default is false. Example: true
    compartmentId string
    (Updatable) The OCID of the compartment to contain the NAT gateway.
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags {[key: string]: any}
    (Updatable) 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"}
    natIp string
    The IP address associated with the NAT gateway.
    publicIpId string
    The OCID of the public IP address associated with the NAT gateway.
    routeTableId string

    (Updatable) The OCID of the route table used by the NAT gateway.

    If you don't specify a route table here, the NAT gateway is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the NAT gateway.

    state string
    The NAT gateway's current state.
    timeCreated string
    The date and time the NAT gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    vcnId string

    The OCID of the VCN the gateway belongs to.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    block_traffic bool
    (Updatable) Whether the NAT gateway blocks traffic through it. The default is false. Example: true
    compartment_id str
    (Updatable) The OCID of the compartment to contain the NAT gateway.
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeform_tags Mapping[str, Any]
    (Updatable) 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"}
    nat_ip str
    The IP address associated with the NAT gateway.
    public_ip_id str
    The OCID of the public IP address associated with the NAT gateway.
    route_table_id str

    (Updatable) The OCID of the route table used by the NAT gateway.

    If you don't specify a route table here, the NAT gateway is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the NAT gateway.

    state str
    The NAT gateway's current state.
    time_created str
    The date and time the NAT gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    vcn_id str

    The OCID of the VCN the gateway belongs to.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    blockTraffic Boolean
    (Updatable) Whether the NAT gateway blocks traffic through it. The default is false. Example: true
    compartmentId String
    (Updatable) The OCID of the compartment to contain the NAT gateway.
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<Any>
    (Updatable) 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"}
    natIp String
    The IP address associated with the NAT gateway.
    publicIpId String
    The OCID of the public IP address associated with the NAT gateway.
    routeTableId String

    (Updatable) The OCID of the route table used by the NAT gateway.

    If you don't specify a route table here, the NAT gateway is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the NAT gateway.

    state String
    The NAT gateway's current state.
    timeCreated String
    The date and time the NAT gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    vcnId String

    The OCID of the VCN the gateway belongs to.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Import

    NatGateways can be imported using the id, e.g.

    $ pulumi import oci:Core/natGateway:NatGateway test_nat_gateway "id"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi