1. Packages
  2. Outscale Provider
  3. API Docs
  4. getNatService
outscale 1.1.0 published on Thursday, Apr 3, 2025 by outscale

outscale.getNatService

Explore with Pulumi AI

Provides information about a NAT service.

For more information on this resource, see the User Guide.
For more information on this resource actions, see the API documentation.

Example Usage

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

const natService01 = outscale.getNatService({
    filters: [{
        name: "nat_service_ids",
        values: ["nat-12345678"],
    }],
});
Copy
import pulumi
import pulumi_outscale as outscale

nat_service01 = outscale.get_nat_service(filters=[{
    "name": "nat_service_ids",
    "values": ["nat-12345678"],
}])
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/outscale/outscale"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := outscale.LookupNatService(ctx, &outscale.LookupNatServiceArgs{
			Filters: []outscale.GetNatServiceFilter{
				{
					Name: "nat_service_ids",
					Values: []string{
						"nat-12345678",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Outscale = Pulumi.Outscale;

return await Deployment.RunAsync(() => 
{
    var natService01 = Outscale.GetNatService.Invoke(new()
    {
        Filters = new[]
        {
            new Outscale.Inputs.GetNatServiceFilterInputArgs
            {
                Name = "nat_service_ids",
                Values = new[]
                {
                    "nat-12345678",
                },
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.outscale.OutscaleFunctions;
import com.pulumi.outscale.inputs.GetNatServiceArgs;
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 natService01 = OutscaleFunctions.getNatService(GetNatServiceArgs.builder()
            .filters(GetNatServiceFilterArgs.builder()
                .name("nat_service_ids")
                .values("nat-12345678")
                .build())
            .build());

    }
}
Copy
variables:
  natService01:
    fn::invoke:
      function: outscale:getNatService
      arguments:
        filters:
          - name: nat_service_ids
            values:
              - nat-12345678
Copy

Using getNatService

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 getNatService(args: GetNatServiceArgs, opts?: InvokeOptions): Promise<GetNatServiceResult>
function getNatServiceOutput(args: GetNatServiceOutputArgs, opts?: InvokeOptions): Output<GetNatServiceResult>
Copy
def get_nat_service(filters: Optional[Sequence[GetNatServiceFilter]] = None,
                    id: Optional[str] = None,
                    nat_service_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetNatServiceResult
def get_nat_service_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetNatServiceFilterArgs]]]] = None,
                    id: Optional[pulumi.Input[str]] = None,
                    nat_service_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetNatServiceResult]
Copy
func LookupNatService(ctx *Context, args *LookupNatServiceArgs, opts ...InvokeOption) (*LookupNatServiceResult, error)
func LookupNatServiceOutput(ctx *Context, args *LookupNatServiceOutputArgs, opts ...InvokeOption) LookupNatServiceResultOutput
Copy

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

public static class GetNatService 
{
    public static Task<GetNatServiceResult> InvokeAsync(GetNatServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetNatServiceResult> Invoke(GetNatServiceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNatServiceResult> getNatService(GetNatServiceArgs args, InvokeOptions options)
public static Output<GetNatServiceResult> getNatService(GetNatServiceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: outscale:index/getNatService:getNatService
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Filters List<GetNatServiceFilter>
A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
Id string
NatServiceId string
The ID of the NAT service.
Filters []GetNatServiceFilter
A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
Id string
NatServiceId string
The ID of the NAT service.
filters List<GetNatServiceFilter>
A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
id String
natServiceId String
The ID of the NAT service.
filters GetNatServiceFilter[]
A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
id string
natServiceId string
The ID of the NAT service.
filters Sequence[GetNatServiceFilter]
A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
id str
nat_service_id str
The ID of the NAT service.
filters List<Property Map>
A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
id String
natServiceId String
The ID of the NAT service.

getNatService Result

The following output properties are available:

Id string
NetId string
The ID of the Net in which the NAT service is.
PublicIps List<GetNatServicePublicIp>
Information about the public IP or IPs associated with the NAT service.
RequestId string
State string
The state of the NAT service (pending | available | deleting | deleted).
SubnetId string
The ID of the Subnet in which the NAT service is.
Tags List<GetNatServiceTag>
One or more tags associated with the NAT service.
Filters List<GetNatServiceFilter>
NatServiceId string
The ID of the NAT service.
Id string
NetId string
The ID of the Net in which the NAT service is.
PublicIps []GetNatServicePublicIp
Information about the public IP or IPs associated with the NAT service.
RequestId string
State string
The state of the NAT service (pending | available | deleting | deleted).
SubnetId string
The ID of the Subnet in which the NAT service is.
Tags []GetNatServiceTag
One or more tags associated with the NAT service.
Filters []GetNatServiceFilter
NatServiceId string
The ID of the NAT service.
id String
netId String
The ID of the Net in which the NAT service is.
publicIps List<GetNatServicePublicIp>
Information about the public IP or IPs associated with the NAT service.
requestId String
state String
The state of the NAT service (pending | available | deleting | deleted).
subnetId String
The ID of the Subnet in which the NAT service is.
tags List<GetNatServiceTag>
One or more tags associated with the NAT service.
filters List<GetNatServiceFilter>
natServiceId String
The ID of the NAT service.
id string
netId string
The ID of the Net in which the NAT service is.
publicIps GetNatServicePublicIp[]
Information about the public IP or IPs associated with the NAT service.
requestId string
state string
The state of the NAT service (pending | available | deleting | deleted).
subnetId string
The ID of the Subnet in which the NAT service is.
tags GetNatServiceTag[]
One or more tags associated with the NAT service.
filters GetNatServiceFilter[]
natServiceId string
The ID of the NAT service.
id str
net_id str
The ID of the Net in which the NAT service is.
public_ips Sequence[GetNatServicePublicIp]
Information about the public IP or IPs associated with the NAT service.
request_id str
state str
The state of the NAT service (pending | available | deleting | deleted).
subnet_id str
The ID of the Subnet in which the NAT service is.
tags Sequence[GetNatServiceTag]
One or more tags associated with the NAT service.
filters Sequence[GetNatServiceFilter]
nat_service_id str
The ID of the NAT service.
id String
netId String
The ID of the Net in which the NAT service is.
publicIps List<Property Map>
Information about the public IP or IPs associated with the NAT service.
requestId String
state String
The state of the NAT service (pending | available | deleting | deleted).
subnetId String
The ID of the Subnet in which the NAT service is.
tags List<Property Map>
One or more tags associated with the NAT service.
filters List<Property Map>
natServiceId String
The ID of the NAT service.

Supporting Types

GetNatServiceFilter

Name This property is required. string
Values This property is required. List<string>
Name This property is required. string
Values This property is required. []string
name This property is required. String
values This property is required. List<String>
name This property is required. string
values This property is required. string[]
name This property is required. str
values This property is required. Sequence[str]
name This property is required. String
values This property is required. List<String>

GetNatServicePublicIp

PublicIp This property is required. string
The public IP associated with the NAT service.
PublicIpId This property is required. string
The allocation ID of the public IP associated with the NAT service.
PublicIp This property is required. string
The public IP associated with the NAT service.
PublicIpId This property is required. string
The allocation ID of the public IP associated with the NAT service.
publicIp This property is required. String
The public IP associated with the NAT service.
publicIpId This property is required. String
The allocation ID of the public IP associated with the NAT service.
publicIp This property is required. string
The public IP associated with the NAT service.
publicIpId This property is required. string
The allocation ID of the public IP associated with the NAT service.
public_ip This property is required. str
The public IP associated with the NAT service.
public_ip_id This property is required. str
The allocation ID of the public IP associated with the NAT service.
publicIp This property is required. String
The public IP associated with the NAT service.
publicIpId This property is required. String
The allocation ID of the public IP associated with the NAT service.

GetNatServiceTag

Key This property is required. string
The key of the tag, with a minimum of 1 character.
Value This property is required. string
The value of the tag, between 0 and 255 characters.
Key This property is required. string
The key of the tag, with a minimum of 1 character.
Value This property is required. string
The value of the tag, between 0 and 255 characters.
key This property is required. String
The key of the tag, with a minimum of 1 character.
value This property is required. String
The value of the tag, between 0 and 255 characters.
key This property is required. string
The key of the tag, with a minimum of 1 character.
value This property is required. string
The value of the tag, between 0 and 255 characters.
key This property is required. str
The key of the tag, with a minimum of 1 character.
value This property is required. str
The value of the tag, between 0 and 255 characters.
key This property is required. String
The key of the tag, with a minimum of 1 character.
value This property is required. String
The value of the tag, between 0 and 255 characters.

Package Details

Repository
outscale outscale/terraform-provider-outscale
License
Notes
This Pulumi package is based on the outscale Terraform Provider.