1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. ServiceGateway
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

oci.Core.ServiceGateway

Explore with Pulumi AI

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

Creates a new service gateway in the specified compartment.

For the purposes of access control, you must provide the OCID of the compartment where you want the service gateway to reside. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.

You may optionally specify a display name for the service gateway, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.

Use the ListServices operation to find service CIDR labels available in the region.

Example Usage

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

const testServiceGateway = new oci.core.ServiceGateway("test_service_gateway", {
    compartmentId: compartmentId,
    services: [{
        serviceId: testServices.services[0].id,
    }],
    vcnId: testVcn.id,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    displayName: serviceGatewayDisplayName,
    freeformTags: {
        Department: "Finance",
    },
    routeTableId: testRouteTable.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_service_gateway = oci.core.ServiceGateway("test_service_gateway",
    compartment_id=compartment_id,
    services=[{
        "service_id": test_services["services"][0]["id"],
    }],
    vcn_id=test_vcn["id"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=service_gateway_display_name,
    freeform_tags={
        "Department": "Finance",
    },
    route_table_id=test_route_table["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.NewServiceGateway(ctx, "test_service_gateway", &core.ServiceGatewayArgs{
			CompartmentId: pulumi.Any(compartmentId),
			Services: core.ServiceGatewayServiceArray{
				&core.ServiceGatewayServiceArgs{
					ServiceId: pulumi.Any(testServices.Services[0].Id),
				},
			},
			VcnId: pulumi.Any(testVcn.Id),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			DisplayName: pulumi.Any(serviceGatewayDisplayName),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			RouteTableId: pulumi.Any(testRouteTable.Id),
		})
		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 testServiceGateway = new Oci.Core.ServiceGateway("test_service_gateway", new()
    {
        CompartmentId = compartmentId,
        Services = new[]
        {
            new Oci.Core.Inputs.ServiceGatewayServiceArgs
            {
                ServiceId = testServices.Services[0].Id,
            },
        },
        VcnId = testVcn.Id,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DisplayName = serviceGatewayDisplayName,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        RouteTableId = testRouteTable.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.ServiceGateway;
import com.pulumi.oci.Core.ServiceGatewayArgs;
import com.pulumi.oci.Core.inputs.ServiceGatewayServiceArgs;
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 testServiceGateway = new ServiceGateway("testServiceGateway", ServiceGatewayArgs.builder()
            .compartmentId(compartmentId)
            .services(ServiceGatewayServiceArgs.builder()
                .serviceId(testServices.services()[0].id())
                .build())
            .vcnId(testVcn.id())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .displayName(serviceGatewayDisplayName)
            .freeformTags(Map.of("Department", "Finance"))
            .routeTableId(testRouteTable.id())
            .build());

    }
}
Copy
resources:
  testServiceGateway:
    type: oci:Core:ServiceGateway
    name: test_service_gateway
    properties:
      compartmentId: ${compartmentId}
      services:
        - serviceId: ${testServices.services[0].id}
      vcnId: ${testVcn.id}
      definedTags:
        Operations.CostCenter: '42'
      displayName: ${serviceGatewayDisplayName}
      freeformTags:
        Department: Finance
      routeTableId: ${testRouteTable.id}
Copy

Create ServiceGateway Resource

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

Constructor syntax

new ServiceGateway(name: string, args: ServiceGatewayArgs, opts?: CustomResourceOptions);
@overload
def ServiceGateway(resource_name: str,
                   args: ServiceGatewayArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def ServiceGateway(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   compartment_id: Optional[str] = None,
                   services: Optional[Sequence[_core.ServiceGatewayServiceArgs]] = None,
                   vcn_id: Optional[str] = None,
                   defined_tags: Optional[Mapping[str, str]] = None,
                   display_name: Optional[str] = None,
                   freeform_tags: Optional[Mapping[str, str]] = None,
                   route_table_id: Optional[str] = None)
func NewServiceGateway(ctx *Context, name string, args ServiceGatewayArgs, opts ...ResourceOption) (*ServiceGateway, error)
public ServiceGateway(string name, ServiceGatewayArgs args, CustomResourceOptions? opts = null)
public ServiceGateway(String name, ServiceGatewayArgs args)
public ServiceGateway(String name, ServiceGatewayArgs args, CustomResourceOptions options)
type: oci:Core:ServiceGateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

Constructor example

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

var serviceGatewayResource = new Oci.Core.ServiceGateway("serviceGatewayResource", new()
{
    CompartmentId = "string",
    Services = new[]
    {
        new Oci.Core.Inputs.ServiceGatewayServiceArgs
        {
            ServiceId = "string",
            ServiceName = "string",
        },
    },
    VcnId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    RouteTableId = "string",
});
Copy
example, err := Core.NewServiceGateway(ctx, "serviceGatewayResource", &Core.ServiceGatewayArgs{
	CompartmentId: pulumi.String("string"),
	Services: core.ServiceGatewayServiceArray{
		&core.ServiceGatewayServiceArgs{
			ServiceId:   pulumi.String("string"),
			ServiceName: pulumi.String("string"),
		},
	},
	VcnId: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	RouteTableId: pulumi.String("string"),
})
Copy
var serviceGatewayResource = new ServiceGateway("serviceGatewayResource", ServiceGatewayArgs.builder()
    .compartmentId("string")
    .services(ServiceGatewayServiceArgs.builder()
        .serviceId("string")
        .serviceName("string")
        .build())
    .vcnId("string")
    .definedTags(Map.of("string", "string"))
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .routeTableId("string")
    .build());
Copy
service_gateway_resource = oci.core.ServiceGateway("serviceGatewayResource",
    compartment_id="string",
    services=[{
        "service_id": "string",
        "service_name": "string",
    }],
    vcn_id="string",
    defined_tags={
        "string": "string",
    },
    display_name="string",
    freeform_tags={
        "string": "string",
    },
    route_table_id="string")
Copy
const serviceGatewayResource = new oci.core.ServiceGateway("serviceGatewayResource", {
    compartmentId: "string",
    services: [{
        serviceId: "string",
        serviceName: "string",
    }],
    vcnId: "string",
    definedTags: {
        string: "string",
    },
    displayName: "string",
    freeformTags: {
        string: "string",
    },
    routeTableId: "string",
});
Copy
type: oci:Core:ServiceGateway
properties:
    compartmentId: string
    definedTags:
        string: string
    displayName: string
    freeformTags:
        string: string
    routeTableId: string
    services:
        - serviceId: string
          serviceName: string
    vcnId: string
Copy

ServiceGateway Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ServiceGateway resource accepts the following input properties:

CompartmentId This property is required. string
(Updatable) The OCID of the compartment to contain the service gateway.
Services This property is required. List<ServiceGatewayService>

(Updatable) List of the OCIDs of the Service objects to enable for the service gateway. This list can be empty if you don't want to enable any Service objects when you create the gateway. You can enable a Service object later by using either AttachServiceId or UpdateServiceGateway.

For each enabled Service, make sure there's a route rule with the Service object's cidrBlock as the rule's destination and the service gateway as the rule's target. See Route Table.

VcnId
This property is required.
Changes to this property will trigger replacement.
string

The OCID of the VCN.

** 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

DefinedTags Dictionary<string, string>
(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, string>
(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"}
RouteTableId string

(Updatable) The OCID of the route table the service gateway will use.

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

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

CompartmentId This property is required. string
(Updatable) The OCID of the compartment to contain the service gateway.
Services This property is required. []ServiceGatewayServiceArgs

(Updatable) List of the OCIDs of the Service objects to enable for the service gateway. This list can be empty if you don't want to enable any Service objects when you create the gateway. You can enable a Service object later by using either AttachServiceId or UpdateServiceGateway.

For each enabled Service, make sure there's a route rule with the Service object's cidrBlock as the rule's destination and the service gateway as the rule's target. See Route Table.

VcnId
This property is required.
Changes to this property will trigger replacement.
string

The OCID of the VCN.

** 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

DefinedTags map[string]string
(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]string
(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"}
RouteTableId string

(Updatable) The OCID of the route table the service gateway will use.

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

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

compartmentId This property is required. String
(Updatable) The OCID of the compartment to contain the service gateway.
services This property is required. List<ServiceGatewayService>

(Updatable) List of the OCIDs of the Service objects to enable for the service gateway. This list can be empty if you don't want to enable any Service objects when you create the gateway. You can enable a Service object later by using either AttachServiceId or UpdateServiceGateway.

For each enabled Service, make sure there's a route rule with the Service object's cidrBlock as the rule's destination and the service gateway as the rule's target. See Route Table.

vcnId
This property is required.
Changes to this property will trigger replacement.
String

The OCID of the VCN.

** 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

definedTags Map<String,String>
(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,String>
(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"}
routeTableId String

(Updatable) The OCID of the route table the service gateway will use.

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

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

compartmentId This property is required. string
(Updatable) The OCID of the compartment to contain the service gateway.
services This property is required. ServiceGatewayService[]

(Updatable) List of the OCIDs of the Service objects to enable for the service gateway. This list can be empty if you don't want to enable any Service objects when you create the gateway. You can enable a Service object later by using either AttachServiceId or UpdateServiceGateway.

For each enabled Service, make sure there's a route rule with the Service object's cidrBlock as the rule's destination and the service gateway as the rule's target. See Route Table.

vcnId
This property is required.
Changes to this property will trigger replacement.
string

The OCID of the VCN.

** 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

definedTags {[key: string]: string}
(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]: string}
(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"}
routeTableId string

(Updatable) The OCID of the route table the service gateway will use.

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

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

compartment_id This property is required. str
(Updatable) The OCID of the compartment to contain the service gateway.
services This property is required. Sequence[core.ServiceGatewayServiceArgs]

(Updatable) List of the OCIDs of the Service objects to enable for the service gateway. This list can be empty if you don't want to enable any Service objects when you create the gateway. You can enable a Service object later by using either AttachServiceId or UpdateServiceGateway.

For each enabled Service, make sure there's a route rule with the Service object's cidrBlock as the rule's destination and the service gateway as the rule's target. See Route Table.

vcn_id
This property is required.
Changes to this property will trigger replacement.
str

The OCID of the VCN.

** 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

defined_tags Mapping[str, str]
(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, str]
(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"}
route_table_id str

(Updatable) The OCID of the route table the service gateway will use.

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

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

compartmentId This property is required. String
(Updatable) The OCID of the compartment to contain the service gateway.
services This property is required. List<Property Map>

(Updatable) List of the OCIDs of the Service objects to enable for the service gateway. This list can be empty if you don't want to enable any Service objects when you create the gateway. You can enable a Service object later by using either AttachServiceId or UpdateServiceGateway.

For each enabled Service, make sure there's a route rule with the Service object's cidrBlock as the rule's destination and the service gateway as the rule's target. See Route Table.

vcnId
This property is required.
Changes to this property will trigger replacement.
String

The OCID of the VCN.

** 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

definedTags Map<String>
(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>
(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"}
routeTableId String

(Updatable) The OCID of the route table the service gateway will use.

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

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

Outputs

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

BlockTraffic bool
Whether the service gateway blocks all traffic through it. The default is false. When this is true, traffic is not routed to any services, regardless of route rules. Example: true
Id string
The provider-assigned unique ID for this managed resource.
State string
The service gateway's current state.
TimeCreated string
The date and time the service gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
BlockTraffic bool
Whether the service gateway blocks all traffic through it. The default is false. When this is true, traffic is not routed to any services, regardless of route rules. Example: true
Id string
The provider-assigned unique ID for this managed resource.
State string
The service gateway's current state.
TimeCreated string
The date and time the service gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
blockTraffic Boolean
Whether the service gateway blocks all traffic through it. The default is false. When this is true, traffic is not routed to any services, regardless of route rules. Example: true
id String
The provider-assigned unique ID for this managed resource.
state String
The service gateway's current state.
timeCreated String
The date and time the service gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
blockTraffic boolean
Whether the service gateway blocks all traffic through it. The default is false. When this is true, traffic is not routed to any services, regardless of route rules. Example: true
id string
The provider-assigned unique ID for this managed resource.
state string
The service gateway's current state.
timeCreated string
The date and time the service gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
block_traffic bool
Whether the service gateway blocks all traffic through it. The default is false. When this is true, traffic is not routed to any services, regardless of route rules. Example: true
id str
The provider-assigned unique ID for this managed resource.
state str
The service gateway's current state.
time_created str
The date and time the service gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
blockTraffic Boolean
Whether the service gateway blocks all traffic through it. The default is false. When this is true, traffic is not routed to any services, regardless of route rules. Example: true
id String
The provider-assigned unique ID for this managed resource.
state String
The service gateway's current state.
timeCreated String
The date and time the service gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Look up Existing ServiceGateway Resource

Get an existing ServiceGateway 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?: ServiceGatewayState, opts?: CustomResourceOptions): ServiceGateway
@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, str]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        route_table_id: Optional[str] = None,
        services: Optional[Sequence[_core.ServiceGatewayServiceArgs]] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        vcn_id: Optional[str] = None) -> ServiceGateway
func GetServiceGateway(ctx *Context, name string, id IDInput, state *ServiceGatewayState, opts ...ResourceOption) (*ServiceGateway, error)
public static ServiceGateway Get(string name, Input<string> id, ServiceGatewayState? state, CustomResourceOptions? opts = null)
public static ServiceGateway get(String name, Output<String> id, ServiceGatewayState state, CustomResourceOptions options)
resources:  _:    type: oci:Core:ServiceGateway    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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
Whether the service gateway blocks all traffic through it. The default is false. When this is true, traffic is not routed to any services, regardless of route rules. Example: true
CompartmentId string
(Updatable) The OCID of the compartment to contain the service gateway.
DefinedTags Dictionary<string, string>
(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, string>
(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"}
RouteTableId string

(Updatable) The OCID of the route table the service gateway will use.

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

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

Services List<ServiceGatewayService>

(Updatable) List of the OCIDs of the Service objects to enable for the service gateway. This list can be empty if you don't want to enable any Service objects when you create the gateway. You can enable a Service object later by using either AttachServiceId or UpdateServiceGateway.

For each enabled Service, make sure there's a route rule with the Service object's cidrBlock as the rule's destination and the service gateway as the rule's target. See Route Table.

State string
The service gateway's current state.
TimeCreated string
The date and time the service gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
VcnId Changes to this property will trigger replacement. string

The OCID of the VCN.

** 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
Whether the service gateway blocks all traffic through it. The default is false. When this is true, traffic is not routed to any services, regardless of route rules. Example: true
CompartmentId string
(Updatable) The OCID of the compartment to contain the service gateway.
DefinedTags map[string]string
(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]string
(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"}
RouteTableId string

(Updatable) The OCID of the route table the service gateway will use.

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

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

Services []ServiceGatewayServiceArgs

(Updatable) List of the OCIDs of the Service objects to enable for the service gateway. This list can be empty if you don't want to enable any Service objects when you create the gateway. You can enable a Service object later by using either AttachServiceId or UpdateServiceGateway.

For each enabled Service, make sure there's a route rule with the Service object's cidrBlock as the rule's destination and the service gateway as the rule's target. See Route Table.

State string
The service gateway's current state.
TimeCreated string
The date and time the service gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
VcnId Changes to this property will trigger replacement. string

The OCID of the VCN.

** 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
Whether the service gateway blocks all traffic through it. The default is false. When this is true, traffic is not routed to any services, regardless of route rules. Example: true
compartmentId String
(Updatable) The OCID of the compartment to contain the service gateway.
definedTags Map<String,String>
(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,String>
(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"}
routeTableId String

(Updatable) The OCID of the route table the service gateway will use.

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

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

services List<ServiceGatewayService>

(Updatable) List of the OCIDs of the Service objects to enable for the service gateway. This list can be empty if you don't want to enable any Service objects when you create the gateway. You can enable a Service object later by using either AttachServiceId or UpdateServiceGateway.

For each enabled Service, make sure there's a route rule with the Service object's cidrBlock as the rule's destination and the service gateway as the rule's target. See Route Table.

state String
The service gateway's current state.
timeCreated String
The date and time the service gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
vcnId Changes to this property will trigger replacement. String

The OCID of the VCN.

** 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
Whether the service gateway blocks all traffic through it. The default is false. When this is true, traffic is not routed to any services, regardless of route rules. Example: true
compartmentId string
(Updatable) The OCID of the compartment to contain the service gateway.
definedTags {[key: string]: string}
(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]: string}
(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"}
routeTableId string

(Updatable) The OCID of the route table the service gateway will use.

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

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

services ServiceGatewayService[]

(Updatable) List of the OCIDs of the Service objects to enable for the service gateway. This list can be empty if you don't want to enable any Service objects when you create the gateway. You can enable a Service object later by using either AttachServiceId or UpdateServiceGateway.

For each enabled Service, make sure there's a route rule with the Service object's cidrBlock as the rule's destination and the service gateway as the rule's target. See Route Table.

state string
The service gateway's current state.
timeCreated string
The date and time the service gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
vcnId Changes to this property will trigger replacement. string

The OCID of the VCN.

** 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
Whether the service gateway blocks all traffic through it. The default is false. When this is true, traffic is not routed to any services, regardless of route rules. Example: true
compartment_id str
(Updatable) The OCID of the compartment to contain the service gateway.
defined_tags Mapping[str, str]
(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, str]
(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"}
route_table_id str

(Updatable) The OCID of the route table the service gateway will use.

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

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

services Sequence[core.ServiceGatewayServiceArgs]

(Updatable) List of the OCIDs of the Service objects to enable for the service gateway. This list can be empty if you don't want to enable any Service objects when you create the gateway. You can enable a Service object later by using either AttachServiceId or UpdateServiceGateway.

For each enabled Service, make sure there's a route rule with the Service object's cidrBlock as the rule's destination and the service gateway as the rule's target. See Route Table.

state str
The service gateway's current state.
time_created str
The date and time the service gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
vcn_id Changes to this property will trigger replacement. str

The OCID of the VCN.

** 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
Whether the service gateway blocks all traffic through it. The default is false. When this is true, traffic is not routed to any services, regardless of route rules. Example: true
compartmentId String
(Updatable) The OCID of the compartment to contain the service gateway.
definedTags Map<String>
(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>
(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"}
routeTableId String

(Updatable) The OCID of the route table the service gateway will use.

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

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

services List<Property Map>

(Updatable) List of the OCIDs of the Service objects to enable for the service gateway. This list can be empty if you don't want to enable any Service objects when you create the gateway. You can enable a Service object later by using either AttachServiceId or UpdateServiceGateway.

For each enabled Service, make sure there's a route rule with the Service object's cidrBlock as the rule's destination and the service gateway as the rule's target. See Route Table.

state String
The service gateway's current state.
timeCreated String
The date and time the service gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
vcnId Changes to this property will trigger replacement. String

The OCID of the VCN.

** 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

Supporting Types

ServiceGatewayService
, ServiceGatewayServiceArgs

ServiceId This property is required. string
(Updatable) The OCID of the Service.
ServiceName string
The name of the service.
ServiceId This property is required. string
(Updatable) The OCID of the Service.
ServiceName string
The name of the service.
serviceId This property is required. String
(Updatable) The OCID of the Service.
serviceName String
The name of the service.
serviceId This property is required. string
(Updatable) The OCID of the Service.
serviceName string
The name of the service.
service_id This property is required. str
(Updatable) The OCID of the Service.
service_name str
The name of the service.
serviceId This property is required. String
(Updatable) The OCID of the Service.
serviceName String
The name of the service.

Import

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

$ pulumi import oci:Core/serviceGateway:ServiceGateway test_service_gateway "id"
Copy

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.