Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ServiceGateway

Represents a router that lets your VCN privately access specific Oracle services such as Object Storage without exposing the VCN to the public internet. Traffic leaving the VCN and destined for a supported Oracle service (see {@link #listServices(ListServicesRequest) listServices}) is routed through the service gateway and does not traverse the internet. The instances in the VCN do not need to have public IP addresses nor be in a public subnet. The VCN does not need an internet gateway for this traffic. For more information, see Access to Oracle Services: Service Gateway.

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

blockTraffic

blockTraffic: boolean

Whether the service gateway blocks all traffic through it. The default is {@code false}. When this is {@code true}, traffic is not routed to any services, regardless of route rules.

Example: {@code true}

compartmentId

compartmentId: string

The OCID of the compartment that contains the service 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 service gateway.

lifecycleState

lifecycleState: LifecycleState

The service gateway's current state.

Optional routeTableId

routeTableId: undefined | string

The OCID of the route table the service gateway is using. For information about why you would associate a route table with a service gateway, see Transit Routing: Private Access to Oracle Services.

services

services: Array<ServiceIdResponseDetails>

List of the Service objects enabled for this service gateway. The list can be empty. You can enable a particular {@code Service} by using {@link #attachServiceId(AttachServiceIdRequest) attachServiceId} or {@link #updateServiceGateway(UpdateServiceGatewayRequest) updateServiceGateway}.

Optional timeCreated

timeCreated: Date

The date and time the service 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 service gateway belongs to.

Functions

getDeserializedJsonObj

getJsonObj