Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ApiGateway
  5. Gateway
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci

oci.ApiGateway.Gateway

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci

This resource provides the Gateway resource in Oracle Cloud Infrastructure API Gateway service.

Creates a new gateway.

Example Usage

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

const testGateway = new oci.apigateway.Gateway("test_gateway", {
    compartmentId: compartmentId,
    endpointType: gatewayEndpointType,
    subnetId: testSubnet.id,
    certificateId: testCertificate.id,
    caBundles: [{
        type: gatewayCaBundlesType,
        caBundleId: testCaBundle.id,
        certificateAuthorityId: testCertificateAuthority.id,
    }],
    definedTags: {
        "Operations.CostCenter": "42",
    },
    displayName: gatewayDisplayName,
    freeformTags: {
        Department: "Finance",
    },
    networkSecurityGroupIds: gatewayNetworkSecurityGroupIds,
    responseCacheDetails: {
        type: gatewayResponseCacheDetailsType,
        authenticationSecretId: testSecret.id,
        authenticationSecretVersionNumber: gatewayResponseCacheDetailsAuthenticationSecretVersionNumber,
        connectTimeoutInMs: gatewayResponseCacheDetailsConnectTimeoutInMs,
        isSslEnabled: gatewayResponseCacheDetailsIsSslEnabled,
        isSslVerifyDisabled: gatewayResponseCacheDetailsIsSslVerifyDisabled,
        readTimeoutInMs: gatewayResponseCacheDetailsReadTimeoutInMs,
        sendTimeoutInMs: gatewayResponseCacheDetailsSendTimeoutInMs,
        servers: [{
            host: gatewayResponseCacheDetailsServersHost,
            port: gatewayResponseCacheDetailsServersPort,
        }],
    },
});
Copy
import pulumi
import pulumi_oci as oci

test_gateway = oci.api_gateway.Gateway("test_gateway",
    compartment_id=compartment_id,
    endpoint_type=gateway_endpoint_type,
    subnet_id=test_subnet["id"],
    certificate_id=test_certificate["id"],
    ca_bundles=[{
        "type": gateway_ca_bundles_type,
        "ca_bundle_id": test_ca_bundle["id"],
        "certificate_authority_id": test_certificate_authority["id"],
    }],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=gateway_display_name,
    freeform_tags={
        "Department": "Finance",
    },
    network_security_group_ids=gateway_network_security_group_ids,
    response_cache_details={
        "type": gateway_response_cache_details_type,
        "authentication_secret_id": test_secret["id"],
        "authentication_secret_version_number": gateway_response_cache_details_authentication_secret_version_number,
        "connect_timeout_in_ms": gateway_response_cache_details_connect_timeout_in_ms,
        "is_ssl_enabled": gateway_response_cache_details_is_ssl_enabled,
        "is_ssl_verify_disabled": gateway_response_cache_details_is_ssl_verify_disabled,
        "read_timeout_in_ms": gateway_response_cache_details_read_timeout_in_ms,
        "send_timeout_in_ms": gateway_response_cache_details_send_timeout_in_ms,
        "servers": [{
            "host": gateway_response_cache_details_servers_host,
            "port": gateway_response_cache_details_servers_port,
        }],
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/apigateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigateway.NewGateway(ctx, "test_gateway", &apigateway.GatewayArgs{
			CompartmentId: pulumi.Any(compartmentId),
			EndpointType:  pulumi.Any(gatewayEndpointType),
			SubnetId:      pulumi.Any(testSubnet.Id),
			CertificateId: pulumi.Any(testCertificate.Id),
			CaBundles: apigateway.GatewayCaBundleArray{
				&apigateway.GatewayCaBundleArgs{
					Type:                   pulumi.Any(gatewayCaBundlesType),
					CaBundleId:             pulumi.Any(testCaBundle.Id),
					CertificateAuthorityId: pulumi.Any(testCertificateAuthority.Id),
				},
			},
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			DisplayName: pulumi.Any(gatewayDisplayName),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			NetworkSecurityGroupIds: pulumi.Any(gatewayNetworkSecurityGroupIds),
			ResponseCacheDetails: &apigateway.GatewayResponseCacheDetailsArgs{
				Type:                              pulumi.Any(gatewayResponseCacheDetailsType),
				AuthenticationSecretId:            pulumi.Any(testSecret.Id),
				AuthenticationSecretVersionNumber: pulumi.Any(gatewayResponseCacheDetailsAuthenticationSecretVersionNumber),
				ConnectTimeoutInMs:                pulumi.Any(gatewayResponseCacheDetailsConnectTimeoutInMs),
				IsSslEnabled:                      pulumi.Any(gatewayResponseCacheDetailsIsSslEnabled),
				IsSslVerifyDisabled:               pulumi.Any(gatewayResponseCacheDetailsIsSslVerifyDisabled),
				ReadTimeoutInMs:                   pulumi.Any(gatewayResponseCacheDetailsReadTimeoutInMs),
				SendTimeoutInMs:                   pulumi.Any(gatewayResponseCacheDetailsSendTimeoutInMs),
				Servers: apigateway.GatewayResponseCacheDetailsServerArray{
					&apigateway.GatewayResponseCacheDetailsServerArgs{
						Host: pulumi.Any(gatewayResponseCacheDetailsServersHost),
						Port: pulumi.Any(gatewayResponseCacheDetailsServersPort),
					},
				},
			},
		})
		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 testGateway = new Oci.ApiGateway.Gateway("test_gateway", new()
    {
        CompartmentId = compartmentId,
        EndpointType = gatewayEndpointType,
        SubnetId = testSubnet.Id,
        CertificateId = testCertificate.Id,
        CaBundles = new[]
        {
            new Oci.ApiGateway.Inputs.GatewayCaBundleArgs
            {
                Type = gatewayCaBundlesType,
                CaBundleId = testCaBundle.Id,
                CertificateAuthorityId = testCertificateAuthority.Id,
            },
        },
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DisplayName = gatewayDisplayName,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        NetworkSecurityGroupIds = gatewayNetworkSecurityGroupIds,
        ResponseCacheDetails = new Oci.ApiGateway.Inputs.GatewayResponseCacheDetailsArgs
        {
            Type = gatewayResponseCacheDetailsType,
            AuthenticationSecretId = testSecret.Id,
            AuthenticationSecretVersionNumber = gatewayResponseCacheDetailsAuthenticationSecretVersionNumber,
            ConnectTimeoutInMs = gatewayResponseCacheDetailsConnectTimeoutInMs,
            IsSslEnabled = gatewayResponseCacheDetailsIsSslEnabled,
            IsSslVerifyDisabled = gatewayResponseCacheDetailsIsSslVerifyDisabled,
            ReadTimeoutInMs = gatewayResponseCacheDetailsReadTimeoutInMs,
            SendTimeoutInMs = gatewayResponseCacheDetailsSendTimeoutInMs,
            Servers = new[]
            {
                new Oci.ApiGateway.Inputs.GatewayResponseCacheDetailsServerArgs
                {
                    Host = gatewayResponseCacheDetailsServersHost,
                    Port = gatewayResponseCacheDetailsServersPort,
                },
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ApiGateway.Gateway;
import com.pulumi.oci.ApiGateway.GatewayArgs;
import com.pulumi.oci.ApiGateway.inputs.GatewayCaBundleArgs;
import com.pulumi.oci.ApiGateway.inputs.GatewayResponseCacheDetailsArgs;
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 testGateway = new Gateway("testGateway", GatewayArgs.builder()
            .compartmentId(compartmentId)
            .endpointType(gatewayEndpointType)
            .subnetId(testSubnet.id())
            .certificateId(testCertificate.id())
            .caBundles(GatewayCaBundleArgs.builder()
                .type(gatewayCaBundlesType)
                .caBundleId(testCaBundle.id())
                .certificateAuthorityId(testCertificateAuthority.id())
                .build())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .displayName(gatewayDisplayName)
            .freeformTags(Map.of("Department", "Finance"))
            .networkSecurityGroupIds(gatewayNetworkSecurityGroupIds)
            .responseCacheDetails(GatewayResponseCacheDetailsArgs.builder()
                .type(gatewayResponseCacheDetailsType)
                .authenticationSecretId(testSecret.id())
                .authenticationSecretVersionNumber(gatewayResponseCacheDetailsAuthenticationSecretVersionNumber)
                .connectTimeoutInMs(gatewayResponseCacheDetailsConnectTimeoutInMs)
                .isSslEnabled(gatewayResponseCacheDetailsIsSslEnabled)
                .isSslVerifyDisabled(gatewayResponseCacheDetailsIsSslVerifyDisabled)
                .readTimeoutInMs(gatewayResponseCacheDetailsReadTimeoutInMs)
                .sendTimeoutInMs(gatewayResponseCacheDetailsSendTimeoutInMs)
                .servers(GatewayResponseCacheDetailsServerArgs.builder()
                    .host(gatewayResponseCacheDetailsServersHost)
                    .port(gatewayResponseCacheDetailsServersPort)
                    .build())
                .build())
            .build());

    }
}
Copy
resources:
  testGateway:
    type: oci:ApiGateway:Gateway
    name: test_gateway
    properties:
      compartmentId: ${compartmentId}
      endpointType: ${gatewayEndpointType}
      subnetId: ${testSubnet.id}
      certificateId: ${testCertificate.id}
      caBundles:
        - type: ${gatewayCaBundlesType}
          caBundleId: ${testCaBundle.id}
          certificateAuthorityId: ${testCertificateAuthority.id}
      definedTags:
        Operations.CostCenter: '42'
      displayName: ${gatewayDisplayName}
      freeformTags:
        Department: Finance
      networkSecurityGroupIds: ${gatewayNetworkSecurityGroupIds}
      responseCacheDetails:
        type: ${gatewayResponseCacheDetailsType}
        authenticationSecretId: ${testSecret.id}
        authenticationSecretVersionNumber: ${gatewayResponseCacheDetailsAuthenticationSecretVersionNumber}
        connectTimeoutInMs: ${gatewayResponseCacheDetailsConnectTimeoutInMs}
        isSslEnabled: ${gatewayResponseCacheDetailsIsSslEnabled}
        isSslVerifyDisabled: ${gatewayResponseCacheDetailsIsSslVerifyDisabled}
        readTimeoutInMs: ${gatewayResponseCacheDetailsReadTimeoutInMs}
        sendTimeoutInMs: ${gatewayResponseCacheDetailsSendTimeoutInMs}
        servers:
          - host: ${gatewayResponseCacheDetailsServersHost}
            port: ${gatewayResponseCacheDetailsServersPort}
Copy

Create Gateway Resource

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

Constructor syntax

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

@overload
def Gateway(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            compartment_id: Optional[str] = None,
            endpoint_type: Optional[str] = None,
            subnet_id: Optional[str] = None,
            ca_bundles: Optional[Sequence[_apigateway.GatewayCaBundleArgs]] = None,
            certificate_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, str]] = None,
            display_name: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, str]] = None,
            network_security_group_ids: Optional[Sequence[str]] = None,
            response_cache_details: Optional[_apigateway.GatewayResponseCacheDetailsArgs] = None)
func NewGateway(ctx *Context, name string, args GatewayArgs, opts ...ResourceOption) (*Gateway, error)
public Gateway(string name, GatewayArgs args, CustomResourceOptions? opts = null)
public Gateway(String name, GatewayArgs args)
public Gateway(String name, GatewayArgs args, CustomResourceOptions options)

type: oci:ApiGateway:Gateway
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. GatewayArgs
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. GatewayArgs
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. GatewayArgs
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. GatewayArgs
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. GatewayArgs
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 gatewayResource = new Oci.ApiGateway.Gateway("gatewayResource", new()
{
    CompartmentId = "string",
    EndpointType = "string",
    SubnetId = "string",
    CaBundles = new[]
    {
        new Oci.ApiGateway.Inputs.GatewayCaBundleArgs
        {
            Type = "string",
            CaBundleId = "string",
            CertificateAuthorityId = "string",
        },
    },
    CertificateId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    NetworkSecurityGroupIds = new[]
    {
        "string",
    },
    ResponseCacheDetails = new Oci.ApiGateway.Inputs.GatewayResponseCacheDetailsArgs
    {
        Type = "string",
        AuthenticationSecretId = "string",
        AuthenticationSecretVersionNumber = "string",
        ConnectTimeoutInMs = 0,
        IsSslEnabled = false,
        IsSslVerifyDisabled = false,
        ReadTimeoutInMs = 0,
        SendTimeoutInMs = 0,
        Servers = new[]
        {
            new Oci.ApiGateway.Inputs.GatewayResponseCacheDetailsServerArgs
            {
                Host = "string",
                Port = 0,
            },
        },
    },
});
Copy
example, err := ApiGateway.NewGateway(ctx, "gatewayResource", &ApiGateway.GatewayArgs{
	CompartmentId: pulumi.String("string"),
	EndpointType:  pulumi.String("string"),
	SubnetId:      pulumi.String("string"),
	CaBundles: apigateway.GatewayCaBundleArray{
		&apigateway.GatewayCaBundleArgs{
			Type:                   pulumi.String("string"),
			CaBundleId:             pulumi.String("string"),
			CertificateAuthorityId: pulumi.String("string"),
		},
	},
	CertificateId: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	NetworkSecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	ResponseCacheDetails: &apigateway.GatewayResponseCacheDetailsArgs{
		Type:                              pulumi.String("string"),
		AuthenticationSecretId:            pulumi.String("string"),
		AuthenticationSecretVersionNumber: pulumi.String("string"),
		ConnectTimeoutInMs:                pulumi.Int(0),
		IsSslEnabled:                      pulumi.Bool(false),
		IsSslVerifyDisabled:               pulumi.Bool(false),
		ReadTimeoutInMs:                   pulumi.Int(0),
		SendTimeoutInMs:                   pulumi.Int(0),
		Servers: apigateway.GatewayResponseCacheDetailsServerArray{
			&apigateway.GatewayResponseCacheDetailsServerArgs{
				Host: pulumi.String("string"),
				Port: pulumi.Int(0),
			},
		},
	},
})
Copy
var gatewayResource = new Gateway("gatewayResource", GatewayArgs.builder()
    .compartmentId("string")
    .endpointType("string")
    .subnetId("string")
    .caBundles(GatewayCaBundleArgs.builder()
        .type("string")
        .caBundleId("string")
        .certificateAuthorityId("string")
        .build())
    .certificateId("string")
    .definedTags(Map.of("string", "string"))
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .networkSecurityGroupIds("string")
    .responseCacheDetails(GatewayResponseCacheDetailsArgs.builder()
        .type("string")
        .authenticationSecretId("string")
        .authenticationSecretVersionNumber("string")
        .connectTimeoutInMs(0)
        .isSslEnabled(false)
        .isSslVerifyDisabled(false)
        .readTimeoutInMs(0)
        .sendTimeoutInMs(0)
        .servers(GatewayResponseCacheDetailsServerArgs.builder()
            .host("string")
            .port(0)
            .build())
        .build())
    .build());
Copy
gateway_resource = oci.api_gateway.Gateway("gatewayResource",
    compartment_id="string",
    endpoint_type="string",
    subnet_id="string",
    ca_bundles=[{
        "type": "string",
        "ca_bundle_id": "string",
        "certificate_authority_id": "string",
    }],
    certificate_id="string",
    defined_tags={
        "string": "string",
    },
    display_name="string",
    freeform_tags={
        "string": "string",
    },
    network_security_group_ids=["string"],
    response_cache_details={
        "type": "string",
        "authentication_secret_id": "string",
        "authentication_secret_version_number": "string",
        "connect_timeout_in_ms": 0,
        "is_ssl_enabled": False,
        "is_ssl_verify_disabled": False,
        "read_timeout_in_ms": 0,
        "send_timeout_in_ms": 0,
        "servers": [{
            "host": "string",
            "port": 0,
        }],
    })
Copy
const gatewayResource = new oci.apigateway.Gateway("gatewayResource", {
    compartmentId: "string",
    endpointType: "string",
    subnetId: "string",
    caBundles: [{
        type: "string",
        caBundleId: "string",
        certificateAuthorityId: "string",
    }],
    certificateId: "string",
    definedTags: {
        string: "string",
    },
    displayName: "string",
    freeformTags: {
        string: "string",
    },
    networkSecurityGroupIds: ["string"],
    responseCacheDetails: {
        type: "string",
        authenticationSecretId: "string",
        authenticationSecretVersionNumber: "string",
        connectTimeoutInMs: 0,
        isSslEnabled: false,
        isSslVerifyDisabled: false,
        readTimeoutInMs: 0,
        sendTimeoutInMs: 0,
        servers: [{
            host: "string",
            port: 0,
        }],
    },
});
Copy
type: oci:ApiGateway:Gateway
properties:
    caBundles:
        - caBundleId: string
          certificateAuthorityId: string
          type: string
    certificateId: string
    compartmentId: string
    definedTags:
        string: string
    displayName: string
    endpointType: string
    freeformTags:
        string: string
    networkSecurityGroupIds:
        - string
    responseCacheDetails:
        authenticationSecretId: string
        authenticationSecretVersionNumber: string
        connectTimeoutInMs: 0
        isSslEnabled: false
        isSslVerifyDisabled: false
        readTimeoutInMs: 0
        sendTimeoutInMs: 0
        servers:
            - host: string
              port: 0
        type: string
    subnetId: string
Copy

Gateway 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 Gateway resource accepts the following input properties:

CompartmentId This property is required. string
(Updatable) The OCID of the compartment in which the resource is created.
EndpointType
This property is required.
Changes to this property will trigger replacement.
string
Gateway endpoint type. PUBLIC will have a public ip address assigned to it, while PRIVATE will only be accessible on a private IP address on the subnet. Example: PUBLIC or PRIVATE
SubnetId
This property is required.
Changes to this property will trigger replacement.
string

The OCID of the subnet in which related resources are created.

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

CaBundles List<GatewayCaBundle>
(Updatable) An array of CA bundles that should be used on the Gateway for TLS validation.
CertificateId string
(Updatable) The OCID of the resource.
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. Example: My new resource
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"}
NetworkSecurityGroupIds List<string>
(Updatable) An array of Network Security Groups OCIDs associated with this API Gateway.
ResponseCacheDetails GatewayResponseCacheDetails
(Updatable) Base Gateway response cache.
CompartmentId This property is required. string
(Updatable) The OCID of the compartment in which the resource is created.
EndpointType
This property is required.
Changes to this property will trigger replacement.
string
Gateway endpoint type. PUBLIC will have a public ip address assigned to it, while PRIVATE will only be accessible on a private IP address on the subnet. Example: PUBLIC or PRIVATE
SubnetId
This property is required.
Changes to this property will trigger replacement.
string

The OCID of the subnet in which related resources are created.

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

CaBundles []GatewayCaBundleArgs
(Updatable) An array of CA bundles that should be used on the Gateway for TLS validation.
CertificateId string
(Updatable) The OCID of the resource.
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. Example: My new resource
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"}
NetworkSecurityGroupIds []string
(Updatable) An array of Network Security Groups OCIDs associated with this API Gateway.
ResponseCacheDetails GatewayResponseCacheDetailsArgs
(Updatable) Base Gateway response cache.
compartmentId This property is required. String
(Updatable) The OCID of the compartment in which the resource is created.
endpointType
This property is required.
Changes to this property will trigger replacement.
String
Gateway endpoint type. PUBLIC will have a public ip address assigned to it, while PRIVATE will only be accessible on a private IP address on the subnet. Example: PUBLIC or PRIVATE
subnetId
This property is required.
Changes to this property will trigger replacement.
String

The OCID of the subnet in which related resources are created.

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

caBundles List<GatewayCaBundle>
(Updatable) An array of CA bundles that should be used on the Gateway for TLS validation.
certificateId String
(Updatable) The OCID of the resource.
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. Example: My new resource
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"}
networkSecurityGroupIds List<String>
(Updatable) An array of Network Security Groups OCIDs associated with this API Gateway.
responseCacheDetails GatewayResponseCacheDetails
(Updatable) Base Gateway response cache.
compartmentId This property is required. string
(Updatable) The OCID of the compartment in which the resource is created.
endpointType
This property is required.
Changes to this property will trigger replacement.
string
Gateway endpoint type. PUBLIC will have a public ip address assigned to it, while PRIVATE will only be accessible on a private IP address on the subnet. Example: PUBLIC or PRIVATE
subnetId
This property is required.
Changes to this property will trigger replacement.
string

The OCID of the subnet in which related resources are created.

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

caBundles GatewayCaBundle[]
(Updatable) An array of CA bundles that should be used on the Gateway for TLS validation.
certificateId string
(Updatable) The OCID of the resource.
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. Example: My new resource
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"}
networkSecurityGroupIds string[]
(Updatable) An array of Network Security Groups OCIDs associated with this API Gateway.
responseCacheDetails GatewayResponseCacheDetails
(Updatable) Base Gateway response cache.
compartment_id This property is required. str
(Updatable) The OCID of the compartment in which the resource is created.
endpoint_type
This property is required.
Changes to this property will trigger replacement.
str
Gateway endpoint type. PUBLIC will have a public ip address assigned to it, while PRIVATE will only be accessible on a private IP address on the subnet. Example: PUBLIC or PRIVATE
subnet_id
This property is required.
Changes to this property will trigger replacement.
str

The OCID of the subnet in which related resources are created.

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

ca_bundles Sequence[apigateway.GatewayCaBundleArgs]
(Updatable) An array of CA bundles that should be used on the Gateway for TLS validation.
certificate_id str
(Updatable) The OCID of the resource.
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. Example: My new resource
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"}
network_security_group_ids Sequence[str]
(Updatable) An array of Network Security Groups OCIDs associated with this API Gateway.
response_cache_details apigateway.GatewayResponseCacheDetailsArgs
(Updatable) Base Gateway response cache.
compartmentId This property is required. String
(Updatable) The OCID of the compartment in which the resource is created.
endpointType
This property is required.
Changes to this property will trigger replacement.
String
Gateway endpoint type. PUBLIC will have a public ip address assigned to it, while PRIVATE will only be accessible on a private IP address on the subnet. Example: PUBLIC or PRIVATE
subnetId
This property is required.
Changes to this property will trigger replacement.
String

The OCID of the subnet in which related resources are created.

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

caBundles List<Property Map>
(Updatable) An array of CA bundles that should be used on the Gateway for TLS validation.
certificateId String
(Updatable) The OCID of the resource.
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. Example: My new resource
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"}
networkSecurityGroupIds List<String>
(Updatable) An array of Network Security Groups OCIDs associated with this API Gateway.
responseCacheDetails Property Map
(Updatable) Base Gateway response cache.

Outputs

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

Hostname string
The hostname for APIs deployed on the gateway.
Id string
The provider-assigned unique ID for this managed resource.
IpAddresses List<GatewayIpAddress>
An array of IP addresses associated with the gateway.
LifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
State string
The current state of the gateway.
TimeCreated string
The time this resource was created. An RFC3339 formatted datetime string.
TimeUpdated string
The time this resource was last updated. An RFC3339 formatted datetime string.
Hostname string
The hostname for APIs deployed on the gateway.
Id string
The provider-assigned unique ID for this managed resource.
IpAddresses []GatewayIpAddress
An array of IP addresses associated with the gateway.
LifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
State string
The current state of the gateway.
TimeCreated string
The time this resource was created. An RFC3339 formatted datetime string.
TimeUpdated string
The time this resource was last updated. An RFC3339 formatted datetime string.
hostname String
The hostname for APIs deployed on the gateway.
id String
The provider-assigned unique ID for this managed resource.
ipAddresses List<GatewayIpAddress>
An array of IP addresses associated with the gateway.
lifecycleDetails String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
state String
The current state of the gateway.
timeCreated String
The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated String
The time this resource was last updated. An RFC3339 formatted datetime string.
hostname string
The hostname for APIs deployed on the gateway.
id string
The provider-assigned unique ID for this managed resource.
ipAddresses GatewayIpAddress[]
An array of IP addresses associated with the gateway.
lifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
state string
The current state of the gateway.
timeCreated string
The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated string
The time this resource was last updated. An RFC3339 formatted datetime string.
hostname str
The hostname for APIs deployed on the gateway.
id str
The provider-assigned unique ID for this managed resource.
ip_addresses Sequence[apigateway.GatewayIpAddress]
An array of IP addresses associated with the gateway.
lifecycle_details str
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
state str
The current state of the gateway.
time_created str
The time this resource was created. An RFC3339 formatted datetime string.
time_updated str
The time this resource was last updated. An RFC3339 formatted datetime string.
hostname String
The hostname for APIs deployed on the gateway.
id String
The provider-assigned unique ID for this managed resource.
ipAddresses List<Property Map>
An array of IP addresses associated with the gateway.
lifecycleDetails String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
state String
The current state of the gateway.
timeCreated String
The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated String
The time this resource was last updated. An RFC3339 formatted datetime string.

Look up Existing Gateway Resource

Get an existing Gateway 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?: GatewayState, opts?: CustomResourceOptions): Gateway
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ca_bundles: Optional[Sequence[_apigateway.GatewayCaBundleArgs]] = None,
        certificate_id: Optional[str] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        endpoint_type: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        hostname: Optional[str] = None,
        ip_addresses: Optional[Sequence[_apigateway.GatewayIpAddressArgs]] = None,
        lifecycle_details: Optional[str] = None,
        network_security_group_ids: Optional[Sequence[str]] = None,
        response_cache_details: Optional[_apigateway.GatewayResponseCacheDetailsArgs] = None,
        state: Optional[str] = None,
        subnet_id: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> Gateway
func GetGateway(ctx *Context, name string, id IDInput, state *GatewayState, opts ...ResourceOption) (*Gateway, error)
public static Gateway Get(string name, Input<string> id, GatewayState? state, CustomResourceOptions? opts = null)
public static Gateway get(String name, Output<String> id, GatewayState state, CustomResourceOptions options)
resources:  _:    type: oci:ApiGateway:Gateway    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:
CaBundles List<GatewayCaBundle>
(Updatable) An array of CA bundles that should be used on the Gateway for TLS validation.
CertificateId string
(Updatable) The OCID of the resource.
CompartmentId string
(Updatable) The OCID of the compartment in which the resource is created.
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. Example: My new resource
EndpointType Changes to this property will trigger replacement. string
Gateway endpoint type. PUBLIC will have a public ip address assigned to it, while PRIVATE will only be accessible on a private IP address on the subnet. Example: PUBLIC or PRIVATE
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"}
Hostname string
The hostname for APIs deployed on the gateway.
IpAddresses List<GatewayIpAddress>
An array of IP addresses associated with the gateway.
LifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
NetworkSecurityGroupIds List<string>
(Updatable) An array of Network Security Groups OCIDs associated with this API Gateway.
ResponseCacheDetails GatewayResponseCacheDetails
(Updatable) Base Gateway response cache.
State string
The current state of the gateway.
SubnetId Changes to this property will trigger replacement. string

The OCID of the subnet in which related resources are created.

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

TimeCreated string
The time this resource was created. An RFC3339 formatted datetime string.
TimeUpdated string
The time this resource was last updated. An RFC3339 formatted datetime string.
CaBundles []GatewayCaBundleArgs
(Updatable) An array of CA bundles that should be used on the Gateway for TLS validation.
CertificateId string
(Updatable) The OCID of the resource.
CompartmentId string
(Updatable) The OCID of the compartment in which the resource is created.
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. Example: My new resource
EndpointType Changes to this property will trigger replacement. string
Gateway endpoint type. PUBLIC will have a public ip address assigned to it, while PRIVATE will only be accessible on a private IP address on the subnet. Example: PUBLIC or PRIVATE
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"}
Hostname string
The hostname for APIs deployed on the gateway.
IpAddresses []GatewayIpAddressArgs
An array of IP addresses associated with the gateway.
LifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
NetworkSecurityGroupIds []string
(Updatable) An array of Network Security Groups OCIDs associated with this API Gateway.
ResponseCacheDetails GatewayResponseCacheDetailsArgs
(Updatable) Base Gateway response cache.
State string
The current state of the gateway.
SubnetId Changes to this property will trigger replacement. string

The OCID of the subnet in which related resources are created.

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

TimeCreated string
The time this resource was created. An RFC3339 formatted datetime string.
TimeUpdated string
The time this resource was last updated. An RFC3339 formatted datetime string.
caBundles List<GatewayCaBundle>
(Updatable) An array of CA bundles that should be used on the Gateway for TLS validation.
certificateId String
(Updatable) The OCID of the resource.
compartmentId String
(Updatable) The OCID of the compartment in which the resource is created.
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. Example: My new resource
endpointType Changes to this property will trigger replacement. String
Gateway endpoint type. PUBLIC will have a public ip address assigned to it, while PRIVATE will only be accessible on a private IP address on the subnet. Example: PUBLIC or PRIVATE
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"}
hostname String
The hostname for APIs deployed on the gateway.
ipAddresses List<GatewayIpAddress>
An array of IP addresses associated with the gateway.
lifecycleDetails String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
networkSecurityGroupIds List<String>
(Updatable) An array of Network Security Groups OCIDs associated with this API Gateway.
responseCacheDetails GatewayResponseCacheDetails
(Updatable) Base Gateway response cache.
state String
The current state of the gateway.
subnetId Changes to this property will trigger replacement. String

The OCID of the subnet in which related resources are created.

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

timeCreated String
The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated String
The time this resource was last updated. An RFC3339 formatted datetime string.
caBundles GatewayCaBundle[]
(Updatable) An array of CA bundles that should be used on the Gateway for TLS validation.
certificateId string
(Updatable) The OCID of the resource.
compartmentId string
(Updatable) The OCID of the compartment in which the resource is created.
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. Example: My new resource
endpointType Changes to this property will trigger replacement. string
Gateway endpoint type. PUBLIC will have a public ip address assigned to it, while PRIVATE will only be accessible on a private IP address on the subnet. Example: PUBLIC or PRIVATE
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"}
hostname string
The hostname for APIs deployed on the gateway.
ipAddresses GatewayIpAddress[]
An array of IP addresses associated with the gateway.
lifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
networkSecurityGroupIds string[]
(Updatable) An array of Network Security Groups OCIDs associated with this API Gateway.
responseCacheDetails GatewayResponseCacheDetails
(Updatable) Base Gateway response cache.
state string
The current state of the gateway.
subnetId Changes to this property will trigger replacement. string

The OCID of the subnet in which related resources are created.

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

timeCreated string
The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated string
The time this resource was last updated. An RFC3339 formatted datetime string.
ca_bundles Sequence[apigateway.GatewayCaBundleArgs]
(Updatable) An array of CA bundles that should be used on the Gateway for TLS validation.
certificate_id str
(Updatable) The OCID of the resource.
compartment_id str
(Updatable) The OCID of the compartment in which the resource is created.
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. Example: My new resource
endpoint_type Changes to this property will trigger replacement. str
Gateway endpoint type. PUBLIC will have a public ip address assigned to it, while PRIVATE will only be accessible on a private IP address on the subnet. Example: PUBLIC or PRIVATE
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"}
hostname str
The hostname for APIs deployed on the gateway.
ip_addresses Sequence[apigateway.GatewayIpAddressArgs]
An array of IP addresses associated with the gateway.
lifecycle_details str
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
network_security_group_ids Sequence[str]
(Updatable) An array of Network Security Groups OCIDs associated with this API Gateway.
response_cache_details apigateway.GatewayResponseCacheDetailsArgs
(Updatable) Base Gateway response cache.
state str
The current state of the gateway.
subnet_id Changes to this property will trigger replacement. str

The OCID of the subnet in which related resources are created.

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

time_created str
The time this resource was created. An RFC3339 formatted datetime string.
time_updated str
The time this resource was last updated. An RFC3339 formatted datetime string.
caBundles List<Property Map>
(Updatable) An array of CA bundles that should be used on the Gateway for TLS validation.
certificateId String
(Updatable) The OCID of the resource.
compartmentId String
(Updatable) The OCID of the compartment in which the resource is created.
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. Example: My new resource
endpointType Changes to this property will trigger replacement. String
Gateway endpoint type. PUBLIC will have a public ip address assigned to it, while PRIVATE will only be accessible on a private IP address on the subnet. Example: PUBLIC or PRIVATE
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"}
hostname String
The hostname for APIs deployed on the gateway.
ipAddresses List<Property Map>
An array of IP addresses associated with the gateway.
lifecycleDetails String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
networkSecurityGroupIds List<String>
(Updatable) An array of Network Security Groups OCIDs associated with this API Gateway.
responseCacheDetails Property Map
(Updatable) Base Gateway response cache.
state String
The current state of the gateway.
subnetId Changes to this property will trigger replacement. String

The OCID of the subnet in which related resources are created.

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

timeCreated String
The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated String
The time this resource was last updated. An RFC3339 formatted datetime string.

Supporting Types

GatewayCaBundle
, GatewayCaBundleArgs

Type This property is required. string
(Updatable) Type of the CA bundle
CaBundleId string
(Updatable) The OCID of the resource.
CertificateAuthorityId string
(Updatable) The OCID of the resource.
Type This property is required. string
(Updatable) Type of the CA bundle
CaBundleId string
(Updatable) The OCID of the resource.
CertificateAuthorityId string
(Updatable) The OCID of the resource.
type This property is required. String
(Updatable) Type of the CA bundle
caBundleId String
(Updatable) The OCID of the resource.
certificateAuthorityId String
(Updatable) The OCID of the resource.
type This property is required. string
(Updatable) Type of the CA bundle
caBundleId string
(Updatable) The OCID of the resource.
certificateAuthorityId string
(Updatable) The OCID of the resource.
type This property is required. str
(Updatable) Type of the CA bundle
ca_bundle_id str
(Updatable) The OCID of the resource.
certificate_authority_id str
(Updatable) The OCID of the resource.
type This property is required. String
(Updatable) Type of the CA bundle
caBundleId String
(Updatable) The OCID of the resource.
certificateAuthorityId String
(Updatable) The OCID of the resource.

GatewayIpAddress
, GatewayIpAddressArgs

IpAddress string
An IP address.
IpAddress string
An IP address.
ipAddress String
An IP address.
ipAddress string
An IP address.
ip_address str
An IP address.
ipAddress String
An IP address.

GatewayResponseCacheDetails
, GatewayResponseCacheDetailsArgs

Type This property is required. string
(Updatable) Type of the Response Cache.
AuthenticationSecretId string
(Updatable) The OCID of the Oracle Vault Service secret resource.
AuthenticationSecretVersionNumber string
(Updatable) The version number of the authentication secret to use.
ConnectTimeoutInMs int
(Updatable) Defines the timeout for establishing a connection with the Response Cache.
IsSslEnabled bool
(Updatable) Defines if the connection should be over SSL.
IsSslVerifyDisabled bool
(Updatable) Defines whether or not to uphold SSL verification.
ReadTimeoutInMs int
(Updatable) Defines the timeout for reading data from the Response Cache.
SendTimeoutInMs int
(Updatable) Defines the timeout for transmitting data to the Response Cache.
Servers List<GatewayResponseCacheDetailsServer>
(Updatable) The set of cache store members to connect to. At present only a single server is supported.
Type This property is required. string
(Updatable) Type of the Response Cache.
AuthenticationSecretId string
(Updatable) The OCID of the Oracle Vault Service secret resource.
AuthenticationSecretVersionNumber string
(Updatable) The version number of the authentication secret to use.
ConnectTimeoutInMs int
(Updatable) Defines the timeout for establishing a connection with the Response Cache.
IsSslEnabled bool
(Updatable) Defines if the connection should be over SSL.
IsSslVerifyDisabled bool
(Updatable) Defines whether or not to uphold SSL verification.
ReadTimeoutInMs int
(Updatable) Defines the timeout for reading data from the Response Cache.
SendTimeoutInMs int
(Updatable) Defines the timeout for transmitting data to the Response Cache.
Servers []GatewayResponseCacheDetailsServer
(Updatable) The set of cache store members to connect to. At present only a single server is supported.
type This property is required. String
(Updatable) Type of the Response Cache.
authenticationSecretId String
(Updatable) The OCID of the Oracle Vault Service secret resource.
authenticationSecretVersionNumber String
(Updatable) The version number of the authentication secret to use.
connectTimeoutInMs Integer
(Updatable) Defines the timeout for establishing a connection with the Response Cache.
isSslEnabled Boolean
(Updatable) Defines if the connection should be over SSL.
isSslVerifyDisabled Boolean
(Updatable) Defines whether or not to uphold SSL verification.
readTimeoutInMs Integer
(Updatable) Defines the timeout for reading data from the Response Cache.
sendTimeoutInMs Integer
(Updatable) Defines the timeout for transmitting data to the Response Cache.
servers List<GatewayResponseCacheDetailsServer>
(Updatable) The set of cache store members to connect to. At present only a single server is supported.
type This property is required. string
(Updatable) Type of the Response Cache.
authenticationSecretId string
(Updatable) The OCID of the Oracle Vault Service secret resource.
authenticationSecretVersionNumber string
(Updatable) The version number of the authentication secret to use.
connectTimeoutInMs number
(Updatable) Defines the timeout for establishing a connection with the Response Cache.
isSslEnabled boolean
(Updatable) Defines if the connection should be over SSL.
isSslVerifyDisabled boolean
(Updatable) Defines whether or not to uphold SSL verification.
readTimeoutInMs number
(Updatable) Defines the timeout for reading data from the Response Cache.
sendTimeoutInMs number
(Updatable) Defines the timeout for transmitting data to the Response Cache.
servers GatewayResponseCacheDetailsServer[]
(Updatable) The set of cache store members to connect to. At present only a single server is supported.
type This property is required. str
(Updatable) Type of the Response Cache.
authentication_secret_id str
(Updatable) The OCID of the Oracle Vault Service secret resource.
authentication_secret_version_number str
(Updatable) The version number of the authentication secret to use.
connect_timeout_in_ms int
(Updatable) Defines the timeout for establishing a connection with the Response Cache.
is_ssl_enabled bool
(Updatable) Defines if the connection should be over SSL.
is_ssl_verify_disabled bool
(Updatable) Defines whether or not to uphold SSL verification.
read_timeout_in_ms int
(Updatable) Defines the timeout for reading data from the Response Cache.
send_timeout_in_ms int
(Updatable) Defines the timeout for transmitting data to the Response Cache.
servers Sequence[apigateway.GatewayResponseCacheDetailsServer]
(Updatable) The set of cache store members to connect to. At present only a single server is supported.
type This property is required. String
(Updatable) Type of the Response Cache.
authenticationSecretId String
(Updatable) The OCID of the Oracle Vault Service secret resource.
authenticationSecretVersionNumber String
(Updatable) The version number of the authentication secret to use.
connectTimeoutInMs Number
(Updatable) Defines the timeout for establishing a connection with the Response Cache.
isSslEnabled Boolean
(Updatable) Defines if the connection should be over SSL.
isSslVerifyDisabled Boolean
(Updatable) Defines whether or not to uphold SSL verification.
readTimeoutInMs Number
(Updatable) Defines the timeout for reading data from the Response Cache.
sendTimeoutInMs Number
(Updatable) Defines the timeout for transmitting data to the Response Cache.
servers List<Property Map>
(Updatable) The set of cache store members to connect to. At present only a single server is supported.

GatewayResponseCacheDetailsServer
, GatewayResponseCacheDetailsServerArgs

Host string
(Updatable) Hostname or IP address (IPv4 only) where the cache store is running.
Port int
(Updatable) The port the cache store is exposed on.
Host string
(Updatable) Hostname or IP address (IPv4 only) where the cache store is running.
Port int
(Updatable) The port the cache store is exposed on.
host String
(Updatable) Hostname or IP address (IPv4 only) where the cache store is running.
port Integer
(Updatable) The port the cache store is exposed on.
host string
(Updatable) Hostname or IP address (IPv4 only) where the cache store is running.
port number
(Updatable) The port the cache store is exposed on.
host str
(Updatable) Hostname or IP address (IPv4 only) where the cache store is running.
port int
(Updatable) The port the cache store is exposed on.
host String
(Updatable) Hostname or IP address (IPv4 only) where the cache store is running.
port Number
(Updatable) The port the cache store is exposed on.

Import

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

$ pulumi import oci:ApiGateway/gateway:Gateway test_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.
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci