Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. getServiceGateways
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi
pulumi/pulumi-oci

oci.Core.getServiceGateways

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi
pulumi/pulumi-oci

    This data source provides the list of Service Gateways in Oracle Cloud Infrastructure Core service.

    Lists the service gateways in the specified compartment. You may optionally specify a VCN OCID to filter the results by VCN.

    Example Usage

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

const testServiceGateways = oci.Core.getServiceGateways({
    compartmentId: compartmentId,
    state: serviceGatewayState,
    vcnId: testVcn.id,
});

    import pulumi
import pulumi_oci as oci

test_service_gateways = oci.Core.get_service_gateways(compartment_id=compartment_id,
    state=service_gateway_state,
    vcn_id=test_vcn["id"])

    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.GetServiceGateways(ctx, &core.GetServiceGatewaysArgs{
			CompartmentId: compartmentId,
			State:         pulumi.StringRef(serviceGatewayState),
			VcnId:         pulumi.StringRef(testVcn.Id),
		}, nil)
		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 testServiceGateways = Oci.Core.GetServiceGateways.Invoke(new()
    {
        CompartmentId = compartmentId,
        State = serviceGatewayState,
        VcnId = testVcn.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.CoreFunctions;
import com.pulumi.oci.Core.inputs.GetServiceGatewaysArgs;
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) {
        final var testServiceGateways = CoreFunctions.getServiceGateways(GetServiceGatewaysArgs.builder()
            .compartmentId(compartmentId)
            .state(serviceGatewayState)
            .vcnId(testVcn.id())
            .build());

    }
}

    variables:
  testServiceGateways:
    fn::invoke:
      Function: oci:Core:getServiceGateways
      Arguments:
        compartmentId: ${compartmentId}
        state: ${serviceGatewayState}
        vcnId: ${testVcn.id}

    Using getServiceGateways

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getServiceGateways(args: GetServiceGatewaysArgs, opts?: InvokeOptions): Promise<GetServiceGatewaysResult>
function getServiceGatewaysOutput(args: GetServiceGatewaysOutputArgs, opts?: InvokeOptions): Output<GetServiceGatewaysResult>
    def get_service_gateways(compartment_id: Optional[str] = None,
                         filters: Optional[Sequence[_core.GetServiceGatewaysFilter]] = None,
                         state: Optional[str] = None,
                         vcn_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetServiceGatewaysResult
def get_service_gateways_output(compartment_id: Optional[pulumi.Input[str]] = None,
                         filters: Optional[pulumi.Input[Sequence[pulumi.Input[_core.GetServiceGatewaysFilterArgs]]]] = None,
                         state: Optional[pulumi.Input[str]] = None,
                         vcn_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetServiceGatewaysResult]
    func GetServiceGateways(ctx *Context, args *GetServiceGatewaysArgs, opts ...InvokeOption) (*GetServiceGatewaysResult, error)
func GetServiceGatewaysOutput(ctx *Context, args *GetServiceGatewaysOutputArgs, opts ...InvokeOption) GetServiceGatewaysResultOutput

    > Note: This function is named GetServiceGateways in the Go SDK.

    public static class GetServiceGateways 
{
    public static Task<GetServiceGatewaysResult> InvokeAsync(GetServiceGatewaysArgs args, InvokeOptions? opts = null)
    public static Output<GetServiceGatewaysResult> Invoke(GetServiceGatewaysInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetServiceGatewaysResult> getServiceGateways(GetServiceGatewaysArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: oci:Core/getServiceGateways:getServiceGateways
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The OCID of the compartment.
    Filters List<GetServiceGatewaysFilter>
    State string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    VcnId string
    The OCID of the VCN.
    CompartmentId string
    The OCID of the compartment.
    Filters []GetServiceGatewaysFilter
    State string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    VcnId string
    The OCID of the VCN.
    compartmentId String
    The OCID of the compartment.
    filters List<GetServiceGatewaysFilter>
    state String
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    vcnId String
    The OCID of the VCN.
    compartmentId string
    The OCID of the compartment.
    filters GetServiceGatewaysFilter[]
    state string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    vcnId string
    The OCID of the VCN.
    compartment_id str
    The OCID of the compartment.
    filters Sequence[core.GetServiceGatewaysFilter]
    state str
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    vcn_id str
    The OCID of the VCN.
    compartmentId String
    The OCID of the compartment.
    filters List<Property Map>
    state String
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    vcnId String
    The OCID of the VCN.

    getServiceGateways Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment that contains the service gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    ServiceGateways List<GetServiceGatewaysServiceGateway>
    The list of service_gateways.
    Filters List<GetServiceGatewaysFilter>
    State string
    The service gateway's current state.
    VcnId string
    The OCID of the VCN the service gateway belongs to.
    CompartmentId string
    The OCID of the compartment that contains the service gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    ServiceGateways []GetServiceGatewaysServiceGateway
    The list of service_gateways.
    Filters []GetServiceGatewaysFilter
    State string
    The service gateway's current state.
    VcnId string
    The OCID of the VCN the service gateway belongs to.
    compartmentId String
    The OCID of the compartment that contains the service gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    serviceGateways List<GetServiceGatewaysServiceGateway>
    The list of service_gateways.
    filters List<GetServiceGatewaysFilter>
    state String
    The service gateway's current state.
    vcnId String
    The OCID of the VCN the service gateway belongs to.
    compartmentId string
    The OCID of the compartment that contains the service gateway.
    id string
    The provider-assigned unique ID for this managed resource.
    serviceGateways GetServiceGatewaysServiceGateway[]
    The list of service_gateways.
    filters GetServiceGatewaysFilter[]
    state string
    The service gateway's current state.
    vcnId string
    The OCID of the VCN the service gateway belongs to.
    compartment_id str
    The OCID of the compartment that contains the service gateway.
    id str
    The provider-assigned unique ID for this managed resource.
    service_gateways Sequence[core.GetServiceGatewaysServiceGateway]
    The list of service_gateways.
    filters Sequence[core.GetServiceGatewaysFilter]
    state str
    The service gateway's current state.
    vcn_id str
    The OCID of the VCN the service gateway belongs to.
    compartmentId String
    The OCID of the compartment that contains the service gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    serviceGateways List<Property Map>
    The list of service_gateways.
    filters List<Property Map>
    state String
    The service gateway's current state.
    vcnId String
    The OCID of the VCN the service gateway belongs to.

    Supporting Types

    GetServiceGatewaysFilter

    Name string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    GetServiceGatewaysServiceGateway

    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
    The OCID of the compartment.
    DefinedTags Dictionary<string, string>
    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
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags Dictionary<string, string>
    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"}
    Id string
    The OCID of the service gateway.
    RouteTableId 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 List<GetServiceGatewaysServiceGatewayService>
    List of the Service objects enabled for this service gateway. The list can be empty. You can enable a particular Service by using AttachServiceId or UpdateServiceGateway.
    State string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    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 string
    The OCID of the VCN.
    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
    The OCID of the compartment.
    DefinedTags map[string]string
    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
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags map[string]string
    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"}
    Id string
    The OCID of the service gateway.
    RouteTableId 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 []GetServiceGatewaysServiceGatewayService
    List of the Service objects enabled for this service gateway. The list can be empty. You can enable a particular Service by using AttachServiceId or UpdateServiceGateway.
    State string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    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 string
    The OCID of the VCN.
    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
    The OCID of the compartment.
    definedTags Map<String,String>
    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
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String,String>
    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"}
    id String
    The OCID of the service gateway.
    routeTableId 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 List<GetServiceGatewaysServiceGatewayService>
    List of the Service objects enabled for this service gateway. The list can be empty. You can enable a particular Service by using AttachServiceId or UpdateServiceGateway.
    state String
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    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 String
    The OCID of the VCN.
    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
    The OCID of the compartment.
    definedTags {[key: string]: string}
    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
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags {[key: string]: string}
    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"}
    id string
    The OCID of the service gateway.
    routeTableId 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 GetServiceGatewaysServiceGatewayService[]
    List of the Service objects enabled for this service gateway. The list can be empty. You can enable a particular Service by using AttachServiceId or UpdateServiceGateway.
    state string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    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 string
    The OCID of the VCN.
    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
    The OCID of the compartment.
    defined_tags Mapping[str, str]
    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
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeform_tags Mapping[str, str]
    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"}
    id str
    The OCID of the service gateway.
    route_table_id str
    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 Sequence[core.GetServiceGatewaysServiceGatewayService]
    List of the Service objects enabled for this service gateway. The list can be empty. You can enable a particular Service by using AttachServiceId or UpdateServiceGateway.
    state str
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    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 str
    The OCID of the VCN.
    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
    The OCID of the compartment.
    definedTags Map<String>
    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
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String>
    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"}
    id String
    The OCID of the service gateway.
    routeTableId 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 List<Property Map>
    List of the Service objects enabled for this service gateway. The list can be empty. You can enable a particular Service by using AttachServiceId or UpdateServiceGateway.
    state String
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    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 String
    The OCID of the VCN.

    GetServiceGatewaysServiceGatewayService

    ServiceId string
    The OCID of the service.
    ServiceName string
    The name of the service.
    ServiceId string
    The OCID of the service.
    ServiceName string
    The name of the service.
    serviceId String
    The OCID of the service.
    serviceName String
    The name of the service.
    serviceId string
    The OCID of the service.
    serviceName string
    The name of the service.
    service_id str
    The OCID of the service.
    service_name str
    The name of the service.
    serviceId String
    The OCID of the service.
    serviceName String
    The name of the service.

    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 v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi
    pulumi/pulumi-oci