Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

Gateway

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

Creates a new gateway.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testGateway = new Oci.ApiGateway.Gateway("testGateway", new()
    {
        CompartmentId = @var.Compartment_id,
        EndpointType = @var.Gateway_endpoint_type,
        SubnetId = oci_core_subnet.Test_subnet.Id,
        CertificateId = oci_apigateway_certificate.Test_certificate.Id,
        CaBundles = new[]
        {
            new Oci.ApiGateway.Inputs.GatewayCaBundleArgs
            {
                Type = @var.Gateway_ca_bundles_type,
                CaBundleId = oci_apigateway_ca_bundle.Test_ca_bundle.Id,
                CertificateAuthorityId = oci_apigateway_certificate_authority.Test_certificate_authority.Id,
            },
        },
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DisplayName = @var.Gateway_display_name,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        NetworkSecurityGroupIds = @var.Gateway_network_security_group_ids,
        ResponseCacheDetails = new Oci.ApiGateway.Inputs.GatewayResponseCacheDetailsArgs
        {
            Type = @var.Gateway_response_cache_details_type,
            AuthenticationSecretId = oci_vault_secret.Test_secret.Id,
            AuthenticationSecretVersionNumber = @var.Gateway_response_cache_details_authentication_secret_version_number,
            ConnectTimeoutInMs = @var.Gateway_response_cache_details_connect_timeout_in_ms,
            IsSslEnabled = @var.Gateway_response_cache_details_is_ssl_enabled,
            IsSslVerifyDisabled = @var.Gateway_response_cache_details_is_ssl_verify_disabled,
            ReadTimeoutInMs = @var.Gateway_response_cache_details_read_timeout_in_ms,
            SendTimeoutInMs = @var.Gateway_response_cache_details_send_timeout_in_ms,
            Servers = new[]
            {
                new Oci.ApiGateway.Inputs.GatewayResponseCacheDetailsServerArgs
                {
                    Host = @var.Gateway_response_cache_details_servers_host,
                    Port = @var.Gateway_response_cache_details_servers_port,
                },
            },
        },
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ApiGateway.NewGateway(ctx, "testGateway", &ApiGateway.GatewayArgs{
			CompartmentId: pulumi.Any(_var.Compartment_id),
			EndpointType:  pulumi.Any(_var.Gateway_endpoint_type),
			SubnetId:      pulumi.Any(oci_core_subnet.Test_subnet.Id),
			CertificateId: pulumi.Any(oci_apigateway_certificate.Test_certificate.Id),
			CaBundles: apigateway.GatewayCaBundleArray{
				&apigateway.GatewayCaBundleArgs{
					Type:                   pulumi.Any(_var.Gateway_ca_bundles_type),
					CaBundleId:             pulumi.Any(oci_apigateway_ca_bundle.Test_ca_bundle.Id),
					CertificateAuthorityId: pulumi.Any(oci_apigateway_certificate_authority.Test_certificate_authority.Id),
				},
			},
			DefinedTags: pulumi.AnyMap{
				"Operations.CostCenter": pulumi.Any("42"),
			},
			DisplayName: pulumi.Any(_var.Gateway_display_name),
			FreeformTags: pulumi.AnyMap{
				"Department": pulumi.Any("Finance"),
			},
			NetworkSecurityGroupIds: pulumi.Any(_var.Gateway_network_security_group_ids),
			ResponseCacheDetails: &apigateway.GatewayResponseCacheDetailsArgs{
				Type:                              pulumi.Any(_var.Gateway_response_cache_details_type),
				AuthenticationSecretId:            pulumi.Any(oci_vault_secret.Test_secret.Id),
				AuthenticationSecretVersionNumber: pulumi.Any(_var.Gateway_response_cache_details_authentication_secret_version_number),
				ConnectTimeoutInMs:                pulumi.Any(_var.Gateway_response_cache_details_connect_timeout_in_ms),
				IsSslEnabled:                      pulumi.Any(_var.Gateway_response_cache_details_is_ssl_enabled),
				IsSslVerifyDisabled:               pulumi.Any(_var.Gateway_response_cache_details_is_ssl_verify_disabled),
				ReadTimeoutInMs:                   pulumi.Any(_var.Gateway_response_cache_details_read_timeout_in_ms),
				SendTimeoutInMs:                   pulumi.Any(_var.Gateway_response_cache_details_send_timeout_in_ms),
				Servers: apigateway.GatewayResponseCacheDetailsServerArray{
					&apigateway.GatewayResponseCacheDetailsServerArgs{
						Host: pulumi.Any(_var.Gateway_response_cache_details_servers_host),
						Port: pulumi.Any(_var.Gateway_response_cache_details_servers_port),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
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(var_.compartment_id())
            .endpointType(var_.gateway_endpoint_type())
            .subnetId(oci_core_subnet.test_subnet().id())
            .certificateId(oci_apigateway_certificate.test_certificate().id())
            .caBundles(GatewayCaBundleArgs.builder()
                .type(var_.gateway_ca_bundles_type())
                .caBundleId(oci_apigateway_ca_bundle.test_ca_bundle().id())
                .certificateAuthorityId(oci_apigateway_certificate_authority.test_certificate_authority().id())
                .build())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .displayName(var_.gateway_display_name())
            .freeformTags(Map.of("Department", "Finance"))
            .networkSecurityGroupIds(var_.gateway_network_security_group_ids())
            .responseCacheDetails(GatewayResponseCacheDetailsArgs.builder()
                .type(var_.gateway_response_cache_details_type())
                .authenticationSecretId(oci_vault_secret.test_secret().id())
                .authenticationSecretVersionNumber(var_.gateway_response_cache_details_authentication_secret_version_number())
                .connectTimeoutInMs(var_.gateway_response_cache_details_connect_timeout_in_ms())
                .isSslEnabled(var_.gateway_response_cache_details_is_ssl_enabled())
                .isSslVerifyDisabled(var_.gateway_response_cache_details_is_ssl_verify_disabled())
                .readTimeoutInMs(var_.gateway_response_cache_details_read_timeout_in_ms())
                .sendTimeoutInMs(var_.gateway_response_cache_details_send_timeout_in_ms())
                .servers(GatewayResponseCacheDetailsServerArgs.builder()
                    .host(var_.gateway_response_cache_details_servers_host())
                    .port(var_.gateway_response_cache_details_servers_port())
                    .build())
                .build())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_gateway = oci.api_gateway.Gateway("testGateway",
    compartment_id=var["compartment_id"],
    endpoint_type=var["gateway_endpoint_type"],
    subnet_id=oci_core_subnet["test_subnet"]["id"],
    certificate_id=oci_apigateway_certificate["test_certificate"]["id"],
    ca_bundles=[oci.api_gateway.GatewayCaBundleArgs(
        type=var["gateway_ca_bundles_type"],
        ca_bundle_id=oci_apigateway_ca_bundle["test_ca_bundle"]["id"],
        certificate_authority_id=oci_apigateway_certificate_authority["test_certificate_authority"]["id"],
    )],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=var["gateway_display_name"],
    freeform_tags={
        "Department": "Finance",
    },
    network_security_group_ids=var["gateway_network_security_group_ids"],
    response_cache_details=oci.api_gateway.GatewayResponseCacheDetailsArgs(
        type=var["gateway_response_cache_details_type"],
        authentication_secret_id=oci_vault_secret["test_secret"]["id"],
        authentication_secret_version_number=var["gateway_response_cache_details_authentication_secret_version_number"],
        connect_timeout_in_ms=var["gateway_response_cache_details_connect_timeout_in_ms"],
        is_ssl_enabled=var["gateway_response_cache_details_is_ssl_enabled"],
        is_ssl_verify_disabled=var["gateway_response_cache_details_is_ssl_verify_disabled"],
        read_timeout_in_ms=var["gateway_response_cache_details_read_timeout_in_ms"],
        send_timeout_in_ms=var["gateway_response_cache_details_send_timeout_in_ms"],
        servers=[oci.api_gateway.GatewayResponseCacheDetailsServerArgs(
            host=var["gateway_response_cache_details_servers_host"],
            port=var["gateway_response_cache_details_servers_port"],
        )],
    ))
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testGateway = new oci.apigateway.Gateway("testGateway", {
    compartmentId: _var.compartment_id,
    endpointType: _var.gateway_endpoint_type,
    subnetId: oci_core_subnet.test_subnet.id,
    certificateId: oci_apigateway_certificate.test_certificate.id,
    caBundles: [{
        type: _var.gateway_ca_bundles_type,
        caBundleId: oci_apigateway_ca_bundle.test_ca_bundle.id,
        certificateAuthorityId: oci_apigateway_certificate_authority.test_certificate_authority.id,
    }],
    definedTags: {
        "Operations.CostCenter": "42",
    },
    displayName: _var.gateway_display_name,
    freeformTags: {
        Department: "Finance",
    },
    networkSecurityGroupIds: _var.gateway_network_security_group_ids,
    responseCacheDetails: {
        type: _var.gateway_response_cache_details_type,
        authenticationSecretId: oci_vault_secret.test_secret.id,
        authenticationSecretVersionNumber: _var.gateway_response_cache_details_authentication_secret_version_number,
        connectTimeoutInMs: _var.gateway_response_cache_details_connect_timeout_in_ms,
        isSslEnabled: _var.gateway_response_cache_details_is_ssl_enabled,
        isSslVerifyDisabled: _var.gateway_response_cache_details_is_ssl_verify_disabled,
        readTimeoutInMs: _var.gateway_response_cache_details_read_timeout_in_ms,
        sendTimeoutInMs: _var.gateway_response_cache_details_send_timeout_in_ms,
        servers: [{
            host: _var.gateway_response_cache_details_servers_host,
            port: _var.gateway_response_cache_details_servers_port,
        }],
    },
});
resources:
  testGateway:
    type: oci:ApiGateway:Gateway
    properties:
      #Required
      compartmentId: ${var.compartment_id}
      endpointType: ${var.gateway_endpoint_type}
      subnetId: ${oci_core_subnet.test_subnet.id}
      #Optional
      certificateId: ${oci_apigateway_certificate.test_certificate.id}
      caBundles:
        - type: ${var.gateway_ca_bundles_type}
          caBundleId: ${oci_apigateway_ca_bundle.test_ca_bundle.id}
          certificateAuthorityId: ${oci_apigateway_certificate_authority.test_certificate_authority.id}
      definedTags:
        Operations.CostCenter: 42
      displayName: ${var.gateway_display_name}
      freeformTags:
        Department: Finance
      networkSecurityGroupIds: ${var.gateway_network_security_group_ids}
      responseCacheDetails:
        type: ${var.gateway_response_cache_details_type}
        authenticationSecretId: ${oci_vault_secret.test_secret.id}
        authenticationSecretVersionNumber: ${var.gateway_response_cache_details_authentication_secret_version_number}
        connectTimeoutInMs: ${var.gateway_response_cache_details_connect_timeout_in_ms}
        isSslEnabled: ${var.gateway_response_cache_details_is_ssl_enabled}
        isSslVerifyDisabled: ${var.gateway_response_cache_details_is_ssl_verify_disabled}
        readTimeoutInMs: ${var.gateway_response_cache_details_read_timeout_in_ms}
        sendTimeoutInMs: ${var.gateway_response_cache_details_send_timeout_in_ms}
        servers:
          - host: ${var.gateway_response_cache_details_servers_host}
            port: ${var.gateway_response_cache_details_servers_port}

Create a Gateway Resource

new Gateway(name: string, args: GatewayArgs, opts?: CustomResourceOptions);
@overload
def Gateway(resource_name: 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, Any]] = None,
            display_name: Optional[str] = None,
            endpoint_type: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            network_security_group_ids: Optional[Sequence[str]] = None,
            response_cache_details: Optional[_apigateway.GatewayResponseCacheDetailsArgs] = None,
            subnet_id: Optional[str] = None)
@overload
def Gateway(resource_name: str,
            args: GatewayArgs,
            opts: Optional[ResourceOptions] = 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.

name string
The unique name of the resource.
args GatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args 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 string
The unique name of the resource.
args GatewayArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args GatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args GatewayArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

The Gateway resource accepts the following input properties:

CompartmentId string

(Updatable) The OCID of the compartment in which the resource is created.

EndpointType 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 string

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

CaBundles List<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 Dictionary<string, object>

(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, object>

(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 GatewayResponseCacheDetailsArgs

(Updatable) Base Gateway response cache.

CompartmentId string

(Updatable) The OCID of the compartment in which the resource is created.

EndpointType 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 string

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

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]interface{}

(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]interface{}

(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 String

(Updatable) The OCID of the compartment in which the resource is created.

endpointType 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 String

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

caBundles List<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,Object>

(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,Object>

(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 GatewayResponseCacheDetailsArgs

(Updatable) Base Gateway response cache.

compartmentId string

(Updatable) The OCID of the compartment in which the resource is created.

endpointType 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 string

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

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 {[key: string]: any}

(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]: any}

(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.

compartment_id str

(Updatable) The OCID of the compartment in which the resource is created.

endpoint_type 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 str

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

ca_bundles 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, Any]

(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, Any]

(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 GatewayResponseCacheDetailsArgs

(Updatable) Base Gateway response cache.

compartmentId String

(Updatable) The OCID of the compartment in which the resource is created.

endpointType 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 String

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

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

(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<Any>

(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 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 an 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, Any]] = None,
        display_name: Optional[str] = None,
        endpoint_type: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = 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)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
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<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 Dictionary<string, object>

(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 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, object>

(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<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 List<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 string

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

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]interface{}

(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 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]interface{}

(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 string

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

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<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,Object>

(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 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,Object>

(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<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 List<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 String

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

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 {[key: string]: any}

(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 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]: any}

(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 string

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

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 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, Any]

(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 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, Any]

(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 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 GatewayResponseCacheDetailsArgs

(Updatable) Base Gateway response cache.

state str

The current state of the gateway.

subnet_id str

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

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

(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 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<Any>

(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 String

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

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

Type string

(Updatable) Type of the Response Cache.

CaBundleId string

(Updatable) The OCID of the resource.

CertificateAuthorityId string

(Updatable) The OCID of the resource.

Type string

(Updatable) Type of the Response Cache.

CaBundleId string

(Updatable) The OCID of the resource.

CertificateAuthorityId string

(Updatable) The OCID of the resource.

type String

(Updatable) Type of the Response Cache.

caBundleId String

(Updatable) The OCID of the resource.

certificateAuthorityId String

(Updatable) The OCID of the resource.

type string

(Updatable) Type of the Response Cache.

caBundleId string

(Updatable) The OCID of the resource.

certificateAuthorityId string

(Updatable) The OCID of the resource.

type str

(Updatable) Type of the Response Cache.

ca_bundle_id str

(Updatable) The OCID of the resource.

certificate_authority_id str

(Updatable) The OCID of the resource.

type String

(Updatable) Type of the Response Cache.

caBundleId String

(Updatable) The OCID of the resource.

certificateAuthorityId String

(Updatable) The OCID of the resource.

GatewayIpAddress

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

Type 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 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 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 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 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 GatewayResponseCacheDetailsServer]

(Updatable) The set of cache store members to connect to. At present only a single server is supported.

type 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

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"

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.