Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
oci.ApiGateway.getGateway
Explore with Pulumi AI
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
This data source provides details about a specific Gateway resource in Oracle Cloud Infrastructure API Gateway service.
Gets a gateway by identifier.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testGateway = oci.ApiGateway.getGateway({
gatewayId: testGatewayOciApigatewayGateway.id,
});
import pulumi
import pulumi_oci as oci
test_gateway = oci.ApiGateway.get_gateway(gateway_id=test_gateway_oci_apigateway_gateway["id"])
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.GetGateway(ctx, &apigateway.GetGatewayArgs{
GatewayId: testGatewayOciApigatewayGateway.Id,
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testGateway = Oci.ApiGateway.GetGateway.Invoke(new()
{
GatewayId = testGatewayOciApigatewayGateway.Id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ApiGateway.ApiGatewayFunctions;
import com.pulumi.oci.ApiGateway.inputs.GetGatewayArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var testGateway = ApiGatewayFunctions.getGateway(GetGatewayArgs.builder()
.gatewayId(testGatewayOciApigatewayGateway.id())
.build());
}
}
variables:
testGateway:
fn::invoke:
Function: oci:ApiGateway:getGateway
Arguments:
gatewayId: ${testGatewayOciApigatewayGateway.id}
Using getGateway
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getGateway(args: GetGatewayArgs, opts?: InvokeOptions): Promise<GetGatewayResult>
function getGatewayOutput(args: GetGatewayOutputArgs, opts?: InvokeOptions): Output<GetGatewayResult>
def get_gateway(gateway_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetGatewayResult
def get_gateway_output(gateway_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetGatewayResult]
func GetGateway(ctx *Context, args *GetGatewayArgs, opts ...InvokeOption) (*GetGatewayResult, error)
func GetGatewayOutput(ctx *Context, args *GetGatewayOutputArgs, opts ...InvokeOption) GetGatewayResultOutput
> Note: This function is named GetGateway
in the Go SDK.
public static class GetGateway
{
public static Task<GetGatewayResult> InvokeAsync(GetGatewayArgs args, InvokeOptions? opts = null)
public static Output<GetGatewayResult> Invoke(GetGatewayInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetGatewayResult> getGateway(GetGatewayArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:ApiGateway/getGateway:getGateway
arguments:
# arguments dictionary
The following arguments are supported:
- Gateway
Id string - The ocid of the gateway.
- Gateway
Id string - The ocid of the gateway.
- gateway
Id String - The ocid of the gateway.
- gateway
Id string - The ocid of the gateway.
- gateway_
id str - The ocid of the gateway.
- gateway
Id String - The ocid of the gateway.
getGateway Result
The following output properties are available:
- Ca
Bundles List<GetGateway Ca Bundle> - An array of CA bundles that should be used on the Gateway for TLS validation.
- Certificate
Id string - The OCID of the resource.
- Compartment
Id string - The OCID of the compartment in which the resource is created.
- Dictionary<string, object>
- 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 string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- Endpoint
Type string - Gateway endpoint type.
PUBLIC
will have a public ip address assigned to it, whilePRIVATE
will only be accessible on a private IP address on the subnet. Example:PUBLIC
orPRIVATE
- Dictionary<string, object>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Gateway
Id string - Hostname string
- The hostname for APIs deployed on the gateway.
- Id string
- The OCID of the resource.
- Ip
Addresses List<GetGateway Ip Address> - An array of IP addresses associated with the gateway.
- Lifecycle
Details 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.
- Network
Security List<string>Group Ids - An array of Network Security Groups OCIDs associated with this API Gateway.
- Response
Cache List<GetDetails Gateway Response Cache Detail> - Base Gateway response cache.
- State string
- The current state of the gateway.
- Subnet
Id string - The OCID of the subnet in which related resources are created.
- Time
Created string - The time this resource was created. An RFC3339 formatted datetime string.
- Time
Updated string - The time this resource was last updated. An RFC3339 formatted datetime string.
- Ca
Bundles []GetGateway Ca Bundle - An array of CA bundles that should be used on the Gateway for TLS validation.
- Certificate
Id string - The OCID of the resource.
- Compartment
Id string - The OCID of the compartment in which the resource is created.
- map[string]interface{}
- 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 string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- Endpoint
Type string - Gateway endpoint type.
PUBLIC
will have a public ip address assigned to it, whilePRIVATE
will only be accessible on a private IP address on the subnet. Example:PUBLIC
orPRIVATE
- map[string]interface{}
- 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"}
- Gateway
Id string - Hostname string
- The hostname for APIs deployed on the gateway.
- Id string
- The OCID of the resource.
- Ip
Addresses []GetGateway Ip Address - An array of IP addresses associated with the gateway.
- Lifecycle
Details 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.
- Network
Security []stringGroup Ids - An array of Network Security Groups OCIDs associated with this API Gateway.
- Response
Cache []GetDetails Gateway Response Cache Detail - Base Gateway response cache.
- State string
- The current state of the gateway.
- Subnet
Id string - The OCID of the subnet in which related resources are created.
- Time
Created string - The time this resource was created. An RFC3339 formatted datetime string.
- Time
Updated string - The time this resource was last updated. An RFC3339 formatted datetime string.
- ca
Bundles List<GetGateway Ca Bundle> - An array of CA bundles that should be used on the Gateway for TLS validation.
- certificate
Id String - The OCID of the resource.
- compartment
Id String - The OCID of the compartment in which the resource is created.
- Map<String,Object>
- 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 String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- endpoint
Type String - Gateway endpoint type.
PUBLIC
will have a public ip address assigned to it, whilePRIVATE
will only be accessible on a private IP address on the subnet. Example:PUBLIC
orPRIVATE
- Map<String,Object>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- gateway
Id String - hostname String
- The hostname for APIs deployed on the gateway.
- id String
- The OCID of the resource.
- ip
Addresses List<GetGateway Ip Address> - An array of IP addresses associated with the gateway.
- lifecycle
Details 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.
- network
Security List<String>Group Ids - An array of Network Security Groups OCIDs associated with this API Gateway.
- response
Cache List<GetDetails Gateway Response Cache Detail> - Base Gateway response cache.
- state String
- The current state of the gateway.
- subnet
Id String - The OCID of the subnet in which related resources are created.
- time
Created String - The time this resource was created. An RFC3339 formatted datetime string.
- time
Updated String - The time this resource was last updated. An RFC3339 formatted datetime string.
- ca
Bundles GetGateway Ca Bundle[] - An array of CA bundles that should be used on the Gateway for TLS validation.
- certificate
Id string - The OCID of the resource.
- compartment
Id string - The OCID of the compartment in which the resource is created.
- {[key: string]: any}
- 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 string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- endpoint
Type string - Gateway endpoint type.
PUBLIC
will have a public ip address assigned to it, whilePRIVATE
will only be accessible on a private IP address on the subnet. Example:PUBLIC
orPRIVATE
- {[key: string]: any}
- 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"}
- gateway
Id string - hostname string
- The hostname for APIs deployed on the gateway.
- id string
- The OCID of the resource.
- ip
Addresses GetGateway Ip Address[] - An array of IP addresses associated with the gateway.
- lifecycle
Details 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.
- network
Security string[]Group Ids - An array of Network Security Groups OCIDs associated with this API Gateway.
- response
Cache GetDetails Gateway Response Cache Detail[] - Base Gateway response cache.
- state string
- The current state of the gateway.
- subnet
Id string - The OCID of the subnet in which related resources are created.
- time
Created string - The time this resource was created. An RFC3339 formatted datetime string.
- time
Updated string - The time this resource was last updated. An RFC3339 formatted datetime string.
- ca_
bundles Sequence[apigateway.Get Gateway Ca Bundle] - An array of CA bundles that should be used on the Gateway for TLS validation.
- certificate_
id str - The OCID of the resource.
- compartment_
id str - The OCID of the compartment in which the resource is created.
- Mapping[str, Any]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display_
name str - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- endpoint_
type str - Gateway endpoint type.
PUBLIC
will have a public ip address assigned to it, whilePRIVATE
will only be accessible on a private IP address on the subnet. Example:PUBLIC
orPRIVATE
- Mapping[str, Any]
- 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"}
- gateway_
id str - hostname str
- The hostname for APIs deployed on the gateway.
- id str
- The OCID of the resource.
- ip_
addresses Sequence[apigateway.Get Gateway Ip Address] - 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_ Sequence[str]group_ ids - An array of Network Security Groups OCIDs associated with this API Gateway.
- response_
cache_ Sequence[apigateway.details Get Gateway Response Cache Detail] - 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.
- ca
Bundles List<Property Map> - An array of CA bundles that should be used on the Gateway for TLS validation.
- certificate
Id String - The OCID of the resource.
- compartment
Id String - The OCID of the compartment in which the resource is created.
- Map<Any>
- 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 String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- endpoint
Type String - Gateway endpoint type.
PUBLIC
will have a public ip address assigned to it, whilePRIVATE
will only be accessible on a private IP address on the subnet. Example:PUBLIC
orPRIVATE
- Map<Any>
- 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"}
- gateway
Id String - hostname String
- The hostname for APIs deployed on the gateway.
- id String
- The OCID of the resource.
- ip
Addresses List<Property Map> - An array of IP addresses associated with the gateway.
- lifecycle
Details 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.
- network
Security List<String>Group Ids - An array of Network Security Groups OCIDs associated with this API Gateway.
- response
Cache List<Property Map>Details - Base Gateway response cache.
- state String
- The current state of the gateway.
- subnet
Id String - The OCID of the subnet in which related resources are created.
- time
Created String - The time this resource was created. An RFC3339 formatted datetime string.
- time
Updated String - The time this resource was last updated. An RFC3339 formatted datetime string.
Supporting Types
GetGatewayCaBundle
- Ca
Bundle stringId - The OCID of the resource.
- string
- The OCID of the resource.
- Type string
- Type of the Response Cache.
- Ca
Bundle stringId - The OCID of the resource.
- string
- The OCID of the resource.
- Type string
- Type of the Response Cache.
- ca
Bundle StringId - The OCID of the resource.
- String
- The OCID of the resource.
- type String
- Type of the Response Cache.
- ca
Bundle stringId - The OCID of the resource.
- string
- The OCID of the resource.
- type string
- Type of the Response Cache.
- ca_
bundle_ strid - The OCID of the resource.
- str
- The OCID of the resource.
- type str
- Type of the Response Cache.
- ca
Bundle StringId - The OCID of the resource.
- String
- The OCID of the resource.
- type String
- Type of the Response Cache.
GetGatewayIpAddress
- Ip
Address string - An IP address.
- Ip
Address string - An IP address.
- ip
Address String - An IP address.
- ip
Address string - An IP address.
- ip_
address str - An IP address.
- ip
Address String - An IP address.
GetGatewayResponseCacheDetail
- Authentication
Secret stringId - The OCID of the Oracle Vault Service secret resource.
- Authentication
Secret stringVersion Number - The version number of the authentication secret to use.
- Connect
Timeout intIn Ms - Defines the timeout for establishing a connection with the Response Cache.
- Is
Ssl boolEnabled - Defines if the connection should be over SSL.
- Is
Ssl boolVerify Disabled - Defines whether or not to uphold SSL verification.
- Read
Timeout intIn Ms - Defines the timeout for reading data from the Response Cache.
- Send
Timeout intIn Ms - Defines the timeout for transmitting data to the Response Cache.
- Servers
List<Get
Gateway Response Cache Detail Server> - The set of cache store members to connect to. At present only a single server is supported.
- Type string
- Type of the Response Cache.
- Authentication
Secret stringId - The OCID of the Oracle Vault Service secret resource.
- Authentication
Secret stringVersion Number - The version number of the authentication secret to use.
- Connect
Timeout intIn Ms - Defines the timeout for establishing a connection with the Response Cache.
- Is
Ssl boolEnabled - Defines if the connection should be over SSL.
- Is
Ssl boolVerify Disabled - Defines whether or not to uphold SSL verification.
- Read
Timeout intIn Ms - Defines the timeout for reading data from the Response Cache.
- Send
Timeout intIn Ms - Defines the timeout for transmitting data to the Response Cache.
- Servers
[]Get
Gateway Response Cache Detail Server - The set of cache store members to connect to. At present only a single server is supported.
- Type string
- Type of the Response Cache.
- authentication
Secret StringId - The OCID of the Oracle Vault Service secret resource.
- authentication
Secret StringVersion Number - The version number of the authentication secret to use.
- connect
Timeout IntegerIn Ms - Defines the timeout for establishing a connection with the Response Cache.
- is
Ssl BooleanEnabled - Defines if the connection should be over SSL.
- is
Ssl BooleanVerify Disabled - Defines whether or not to uphold SSL verification.
- read
Timeout IntegerIn Ms - Defines the timeout for reading data from the Response Cache.
- send
Timeout IntegerIn Ms - Defines the timeout for transmitting data to the Response Cache.
- servers
List<Get
Gateway Response Cache Detail Server> - The set of cache store members to connect to. At present only a single server is supported.
- type String
- Type of the Response Cache.
- authentication
Secret stringId - The OCID of the Oracle Vault Service secret resource.
- authentication
Secret stringVersion Number - The version number of the authentication secret to use.
- connect
Timeout numberIn Ms - Defines the timeout for establishing a connection with the Response Cache.
- is
Ssl booleanEnabled - Defines if the connection should be over SSL.
- is
Ssl booleanVerify Disabled - Defines whether or not to uphold SSL verification.
- read
Timeout numberIn Ms - Defines the timeout for reading data from the Response Cache.
- send
Timeout numberIn Ms - Defines the timeout for transmitting data to the Response Cache.
- servers
Get
Gateway Response Cache Detail Server[] - The set of cache store members to connect to. At present only a single server is supported.
- type string
- Type of the Response Cache.
- authentication_
secret_ strid - The OCID of the Oracle Vault Service secret resource.
- authentication_
secret_ strversion_ number - The version number of the authentication secret to use.
- connect_
timeout_ intin_ ms - Defines the timeout for establishing a connection with the Response Cache.
- is_
ssl_ boolenabled - Defines if the connection should be over SSL.
- is_
ssl_ boolverify_ disabled - Defines whether or not to uphold SSL verification.
- read_
timeout_ intin_ ms - Defines the timeout for reading data from the Response Cache.
- send_
timeout_ intin_ ms - Defines the timeout for transmitting data to the Response Cache.
- servers
Sequence[apigateway.
Get Gateway Response Cache Detail Server] - The set of cache store members to connect to. At present only a single server is supported.
- type str
- Type of the Response Cache.
- authentication
Secret StringId - The OCID of the Oracle Vault Service secret resource.
- authentication
Secret StringVersion Number - The version number of the authentication secret to use.
- connect
Timeout NumberIn Ms - Defines the timeout for establishing a connection with the Response Cache.
- is
Ssl BooleanEnabled - Defines if the connection should be over SSL.
- is
Ssl BooleanVerify Disabled - Defines whether or not to uphold SSL verification.
- read
Timeout NumberIn Ms - Defines the timeout for reading data from the Response Cache.
- send
Timeout NumberIn Ms - Defines the timeout for transmitting data to the Response Cache.
- servers List<Property Map>
- The set of cache store members to connect to. At present only a single server is supported.
- type String
- Type of the Response Cache.
GetGatewayResponseCacheDetailServer
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 v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi