Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace NatGateway

A NAT (Network Address Translation) gateway, which represents a router that lets instances without public IPs contact the public internet without exposing the instance to inbound internet traffic. For more information, see NAT Gateway.

To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are 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

blockTraffic

blockTraffic: boolean

Whether the NAT gateway blocks traffic through it. The default is {@code false}.

Example: {@code true}

compartmentId

compartmentId: string

The OCID of the compartment that contains the NAT gateway.

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 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 OCID of the NAT gateway.

lifecycleState

lifecycleState: LifecycleState

The NAT gateway's current state.

natIp

natIp: string

The IP address associated with the NAT gateway.

Optional publicIpId

publicIpId: undefined | string

The OCID of the public IP address associated with the NAT gateway.

Optional routeTableId

routeTableId: undefined | string

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.

timeCreated

timeCreated: Date

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

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

vcnId

vcnId: string

The OCID of the VCN the NAT gateway belongs to.

Functions

getDeserializedJsonObj

getJsonObj