Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace InternetGateway

Represents a router that connects the edge of a VCN with the Internet. For an example scenario that uses an internet gateway, see Typical Networking Service Scenarios.

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

compartmentId

compartmentId: string

The OCID of the compartment containing the internet 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 internet gateway's Oracle ID (OCID).

Optional isEnabled

isEnabled: undefined | false | true

Whether the gateway is enabled. When the gateway is disabled, traffic is not routed to/from the Internet, regardless of route rules.

lifecycleState

lifecycleState: LifecycleState

The internet gateway's current state.

Optional routeTableId

routeTableId: undefined | string

The OCID of the route table the Internet Gateway is using.

Optional timeCreated

timeCreated: Date

The date and time the internet 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 Internet Gateway belongs to.

Functions

getDeserializedJsonObj

getJsonObj