← All packages

Oracle Cloud Infrastructure

Pulumi Official

Package maintained by Pulumi

v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

Source code

getNatGateways

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

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

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testNatGateways = Output.Create(Oci.Core.GetNatGateways.InvokeAsync(new Oci.Core.GetNatGatewaysArgs
        {
            CompartmentId = @var.Compartment_id,
            DisplayName = @var.Nat_gateway_display_name,
            State = @var.Nat_gateway_state,
            VcnId = oci_core_vcn.Test_vcn.Id,
        }));
    }

}

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Core.GetNatGateways(ctx, &core.GetNatGatewaysArgs{
			CompartmentId: _var.Compartment_id,
			DisplayName:   pulumi.StringRef(_var.Nat_gateway_display_name),
			State:         pulumi.StringRef(_var.Nat_gateway_state),
			VcnId:         pulumi.StringRef(oci_core_vcn.Test_vcn.Id),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_nat_gateways = oci.Core.get_nat_gateways(compartment_id=var["compartment_id"],
    display_name=var["nat_gateway_display_name"],
    state=var["nat_gateway_state"],
    vcn_id=oci_core_vcn["test_vcn"]["id"])

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

const testNatGateways = oci.Core.getNatGateways({
    compartmentId: _var.compartment_id,
    displayName: _var.nat_gateway_display_name,
    state: _var.nat_gateway_state,
    vcnId: oci_core_vcn.test_vcn.id,
});

Coming soon!

Using getNatGateways

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 getNatGateways(args: GetNatGatewaysArgs, opts?: InvokeOptions): Promise<GetNatGatewaysResult>
function getNatGatewaysOutput(args: GetNatGatewaysOutputArgs, opts?: InvokeOptions): Output<GetNatGatewaysResult>

def get_nat_gateways(compartment_id: Optional[str] = None,
                     display_name: Optional[str] = None,
                     filters: Optional[Sequence[_core.GetNatGatewaysFilter]] = None,
                     state: Optional[str] = None,
                     vcn_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetNatGatewaysResult
def get_nat_gateways_output(compartment_id: Optional[pulumi.Input[str]] = None,
                     display_name: Optional[pulumi.Input[str]] = None,
                     filters: Optional[pulumi.Input[Sequence[pulumi.Input[_core.GetNatGatewaysFilterArgs]]]] = None,
                     state: Optional[pulumi.Input[str]] = None,
                     vcn_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetNatGatewaysResult]

func GetNatGateways(ctx *Context, args *GetNatGatewaysArgs, opts ...InvokeOption) (*GetNatGatewaysResult, error)
func GetNatGatewaysOutput(ctx *Context, args *GetNatGatewaysOutputArgs, opts ...InvokeOption) GetNatGatewaysResultOutput

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

public static class GetNatGateways 
{
    public static Task<GetNatGatewaysResult> InvokeAsync(GetNatGatewaysArgs args, InvokeOptions? opts = null)
    public static Output<GetNatGatewaysResult> Invoke(GetNatGatewaysInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetNatGatewaysResult> getNatGateways(GetNatGatewaysArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

Fn::Invoke:
  Function: oci:Core/getNatGateways:getNatGateways
  Arguments:
    # Arguments dictionary

The following arguments are supported:

CompartmentId string: The OCID of the compartment.
DisplayName string: A filter to return only resources that match the given display name exactly.
Filters List<GetNatGatewaysFilter>
State string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
VcnId string: The OCID of the VCN.

CompartmentId string: The OCID of the compartment.
DisplayName string: A filter to return only resources that match the given display name exactly.
Filters []GetNatGatewaysFilter
State string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
VcnId string: The OCID of the VCN.

compartmentId String: The OCID of the compartment.
displayName String: A filter to return only resources that match the given display name exactly.
filters List<GetNatGatewaysFilter>
state String: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
vcnId String: The OCID of the VCN.

compartmentId string: The OCID of the compartment.
displayName string: A filter to return only resources that match the given display name exactly.
filters GetNatGatewaysFilter[]
state string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
vcnId string: The OCID of the VCN.

compartment_id str: The OCID of the compartment.
display_name str: A filter to return only resources that match the given display name exactly.
filters GetNatGatewaysFilter]
state str: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
vcn_id str: The OCID of the VCN.

compartmentId String: The OCID of the compartment.
displayName String: A filter to return only resources that match the given display name exactly.
filters List<Property Map>
state String: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
vcnId String: The OCID of the VCN.

getNatGateways Result

The following output properties are available:

CompartmentId string: The OCID of the compartment that contains the NAT gateway.
Id string: The provider-assigned unique ID for this managed resource.
NatGateways List<GetNatGatewaysNatGateway>: The list of nat_gateways.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Filters List<GetNatGatewaysFilter>
State string: The NAT gateway's current state.
VcnId string: The OCID of the VCN the NAT gateway belongs to.

CompartmentId string: The OCID of the compartment that contains the NAT gateway.
Id string: The provider-assigned unique ID for this managed resource.
NatGateways []GetNatGatewaysNatGateway: The list of nat_gateways.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Filters []GetNatGatewaysFilter
State string: The NAT gateway's current state.
VcnId string: The OCID of the VCN the NAT gateway belongs to.

compartmentId String: The OCID of the compartment that contains the NAT gateway.
id String: The provider-assigned unique ID for this managed resource.
natGateways List<GetNatGatewaysNatGateway>: The list of nat_gateways.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters List<GetNatGatewaysFilter>
state String: The NAT gateway's current state.
vcnId String: The OCID of the VCN the NAT gateway belongs to.

compartmentId string: The OCID of the compartment that contains the NAT gateway.
id string: The provider-assigned unique ID for this managed resource.
natGateways GetNatGatewaysNatGateway[]: The list of nat_gateways.
displayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters GetNatGatewaysFilter[]
state string: The NAT gateway's current state.
vcnId string: The OCID of the VCN the NAT gateway belongs to.

compartment_id str: The OCID of the compartment that contains the NAT gateway.
id str: The provider-assigned unique ID for this managed resource.
nat_gateways GetNatGatewaysNatGateway]: The list of nat_gateways.
display_name str: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters GetNatGatewaysFilter]
state str: The NAT gateway's current state.
vcn_id str: The OCID of the VCN the NAT gateway belongs to.

compartmentId String: The OCID of the compartment that contains the NAT gateway.
id String: The provider-assigned unique ID for this managed resource.
natGateways List<Property Map>: The list of nat_gateways.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters List<Property Map>
state String: The NAT gateway's current state.
vcnId String: The OCID of the VCN the NAT gateway belongs to.

Supporting Types

GetNatGatewaysFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

GetNatGatewaysNatGateway

BlockTraffic bool: Whether the NAT gateway blocks traffic through it. The default is false. Example: true
CompartmentId string: The OCID of the compartment.
DefinedTags 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"}
DisplayName string: A filter to return only resources that match the given display name exactly.
FreeformTags 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"}
Id string: The OCID of the NAT gateway.
NatIp string: The IP address associated with the NAT gateway.
PublicIpId string: The OCID of the public IP address associated with the NAT gateway.
State string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
TimeCreated string: The date and time the NAT gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
VcnId string: The OCID of the VCN.

BlockTraffic bool: Whether the NAT gateway blocks traffic through it. The default is false. Example: true
CompartmentId string: The OCID of the compartment.
DefinedTags 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"}
DisplayName string: A filter to return only resources that match the given display name exactly.
FreeformTags 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"}
Id string: The OCID of the NAT gateway.
NatIp string: The IP address associated with the NAT gateway.
PublicIpId string: The OCID of the public IP address associated with the NAT gateway.
State string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
TimeCreated string: The date and time the NAT gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
VcnId string: The OCID of the VCN.

blockTraffic Boolean: Whether the NAT gateway blocks traffic through it. The default is false. Example: true
compartmentId String: The OCID of the compartment.
definedTags 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"}
displayName String: A filter to return only resources that match the given display name exactly.
freeformTags 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"}
id String: The OCID of the NAT gateway.
natIp String: The IP address associated with the NAT gateway.
publicIpId String: The OCID of the public IP address associated with the NAT gateway.
state String: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
timeCreated String: The date and time the NAT gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
vcnId String: The OCID of the VCN.

blockTraffic boolean: Whether the NAT gateway blocks traffic through it. The default is false. Example: true
compartmentId string: The OCID of the compartment.
definedTags {[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"}
displayName string: A filter to return only resources that match the given display name exactly.
freeformTags {[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"}
id string: The OCID of the NAT gateway.
natIp string: The IP address associated with the NAT gateway.
publicIpId string: The OCID of the public IP address associated with the NAT gateway.
state string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
timeCreated string: The date and time the NAT gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
vcnId string: The OCID of the VCN.

block_traffic bool: Whether the NAT gateway blocks traffic through it. The default is false. Example: true
compartment_id str: The OCID of the compartment.
defined_tags 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 filter to return only resources that match the given display name exactly.
freeform_tags 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"}
id str: The OCID of the NAT gateway.
nat_ip str: The IP address associated with the NAT gateway.
public_ip_id str: The OCID of the public IP address associated with the NAT gateway.
state str: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
time_created str: The date and time the NAT gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
vcn_id str: The OCID of the VCN.

blockTraffic Boolean: Whether the NAT gateway blocks traffic through it. The default is false. Example: true
compartmentId String: The OCID of the compartment.
definedTags 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"}
displayName String: A filter to return only resources that match the given display name exactly.
freeformTags 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"}
id String: The OCID of the NAT gateway.
natIp String: The IP address associated with the NAT gateway.
publicIpId String: The OCID of the public IP address associated with the NAT gateway.
state String: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
timeCreated String: The date and time the NAT gateway was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
vcnId String: The OCID of the VCN.

Package Details

Repository: https://github.com/pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.