scm.getNatRule

Strata Cloud Manager v0.4.3 published on Saturday, Nov 8, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-scm

Example Usage

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

// Define the resource (the item to be created via API POST/PUT)
const dnatExternalWebTestCreate = new scm.NatRule("dnat_external_web_test_create", {
    name: "DNAT-External-data-src-test_1",
    description: "Translate public VIP to internal web server.",
    froms: ["zone-untrust"],
    tos: ["zone-untrust"],
    sources: ["any"],
    destinations: ["any"],
    service: "service-http",
    folder: "All",
    natType: "ipv4",
    position: "pre",
    destinationTranslation: {
        translatedAddress: "10.1.1.16",
        translatedPort: 112,
        dnsRewrite: {
            direction: "reverse",
        },
    },
});
// Define the data source (the item to be retrieved via API GET)
const dnatExternalWebTestGet = scm.getNatRuleOutput({
    id: dnatExternalWebTestCreate.id,
});
export const retrievedIDAndName = {
    id: dnatExternalWebTestGet.apply(dnatExternalWebTestGet => dnatExternalWebTestGet.id),
    name: dnatExternalWebTestGet.apply(dnatExternalWebTestGet => dnatExternalWebTestGet.name),
};
export const retrievedDestinationTranslation = dnatExternalWebTestGet.apply(dnatExternalWebTestGet => dnatExternalWebTestGet.destinationTranslation);
export const recievedResponse = dnatExternalWebTestGet;

import pulumi
import pulumi_scm as scm

# Define the resource (the item to be created via API POST/PUT)
dnat_external_web_test_create = scm.NatRule("dnat_external_web_test_create",
    name="DNAT-External-data-src-test_1",
    description="Translate public VIP to internal web server.",
    froms=["zone-untrust"],
    tos=["zone-untrust"],
    sources=["any"],
    destinations=["any"],
    service="service-http",
    folder="All",
    nat_type="ipv4",
    position="pre",
    destination_translation={
        "translated_address": "10.1.1.16",
        "translated_port": 112,
        "dns_rewrite": {
            "direction": "reverse",
        },
    })
# Define the data source (the item to be retrieved via API GET)
dnat_external_web_test_get = scm.get_nat_rule_output(id=dnat_external_web_test_create.id)
pulumi.export("retrievedIDAndName", {
    "id": dnat_external_web_test_get.id,
    "name": dnat_external_web_test_get.name,
})
pulumi.export("retrievedDestinationTranslation", dnat_external_web_test_get.destination_translation)
pulumi.export("recievedResponse", dnat_external_web_test_get)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Define the resource (the item to be created via API POST/PUT)
		dnatExternalWebTestCreate, err := scm.NewNatRule(ctx, "dnat_external_web_test_create", &scm.NatRuleArgs{
			Name:        pulumi.String("DNAT-External-data-src-test_1"),
			Description: pulumi.String("Translate public VIP to internal web server."),
			Froms: pulumi.StringArray{
				pulumi.String("zone-untrust"),
			},
			Tos: pulumi.StringArray{
				pulumi.String("zone-untrust"),
			},
			Sources: pulumi.StringArray{
				pulumi.String("any"),
			},
			Destinations: pulumi.StringArray{
				pulumi.String("any"),
			},
			Service:  pulumi.String("service-http"),
			Folder:   pulumi.String("All"),
			NatType:  pulumi.String("ipv4"),
			Position: pulumi.String("pre"),
			DestinationTranslation: &scm.NatRuleDestinationTranslationArgs{
				TranslatedAddress: pulumi.String("10.1.1.16"),
				TranslatedPort:    pulumi.Int(112),
				DnsRewrite: &scm.NatRuleDestinationTranslationDnsRewriteArgs{
					Direction: pulumi.String("reverse"),
				},
			},
		})
		if err != nil {
			return err
		}
		// Define the data source (the item to be retrieved via API GET)
		dnatExternalWebTestGet := scm.LookupNatRuleOutput(ctx, scm.GetNatRuleOutputArgs{
			Id: dnatExternalWebTestCreate.ID(),
		}, nil)
		ctx.Export("retrievedIDAndName", pulumi.StringMap{
			"id": dnatExternalWebTestGet.ApplyT(func(dnatExternalWebTestGet scm.GetNatRuleResult) (*string, error) {
				return &dnatExternalWebTestGet.Id, nil
			}).(pulumi.StringPtrOutput),
			"name": dnatExternalWebTestGet.ApplyT(func(dnatExternalWebTestGet scm.GetNatRuleResult) (*string, error) {
				return &dnatExternalWebTestGet.Name, nil
			}).(pulumi.StringPtrOutput),
		})
		ctx.Export("retrievedDestinationTranslation", dnatExternalWebTestGet.ApplyT(func(dnatExternalWebTestGet scm.GetNatRuleResult) (scm.GetNatRuleDestinationTranslation, error) {
			return dnatExternalWebTestGet.DestinationTranslation, nil
		}).(scm.GetNatRuleDestinationTranslationOutput))
		ctx.Export("recievedResponse", dnatExternalWebTestGet)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;

return await Deployment.RunAsync(() => 
{
    // Define the resource (the item to be created via API POST/PUT)
    var dnatExternalWebTestCreate = new Scm.NatRule("dnat_external_web_test_create", new()
    {
        Name = "DNAT-External-data-src-test_1",
        Description = "Translate public VIP to internal web server.",
        Froms = new[]
        {
            "zone-untrust",
        },
        Tos = new[]
        {
            "zone-untrust",
        },
        Sources = new[]
        {
            "any",
        },
        Destinations = new[]
        {
            "any",
        },
        Service = "service-http",
        Folder = "All",
        NatType = "ipv4",
        Position = "pre",
        DestinationTranslation = new Scm.Inputs.NatRuleDestinationTranslationArgs
        {
            TranslatedAddress = "10.1.1.16",
            TranslatedPort = 112,
            DnsRewrite = new Scm.Inputs.NatRuleDestinationTranslationDnsRewriteArgs
            {
                Direction = "reverse",
            },
        },
    });

    // Define the data source (the item to be retrieved via API GET)
    var dnatExternalWebTestGet = Scm.GetNatRule.Invoke(new()
    {
        Id = dnatExternalWebTestCreate.Id,
    });

    return new Dictionary<string, object?>
    {
        ["retrievedIDAndName"] = 
        {
            { "id", dnatExternalWebTestGet.Apply(getNatRuleResult => getNatRuleResult.Id) },
            { "name", dnatExternalWebTestGet.Apply(getNatRuleResult => getNatRuleResult.Name) },
        },
        ["retrievedDestinationTranslation"] = dnatExternalWebTestGet.Apply(getNatRuleResult => getNatRuleResult.DestinationTranslation),
        ["recievedResponse"] = dnatExternalWebTestGet,
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.NatRule;
import com.pulumi.scm.NatRuleArgs;
import com.pulumi.scm.inputs.NatRuleDestinationTranslationArgs;
import com.pulumi.scm.inputs.NatRuleDestinationTranslationDnsRewriteArgs;
import com.pulumi.scm.ScmFunctions;
import com.pulumi.scm.inputs.GetNatRuleArgs;
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) {
        // Define the resource (the item to be created via API POST/PUT)
        var dnatExternalWebTestCreate = new NatRule("dnatExternalWebTestCreate", NatRuleArgs.builder()
            .name("DNAT-External-data-src-test_1")
            .description("Translate public VIP to internal web server.")
            .froms("zone-untrust")
            .tos("zone-untrust")
            .sources("any")
            .destinations("any")
            .service("service-http")
            .folder("All")
            .natType("ipv4")
            .position("pre")
            .destinationTranslation(NatRuleDestinationTranslationArgs.builder()
                .translatedAddress("10.1.1.16")
                .translatedPort(112)
                .dnsRewrite(NatRuleDestinationTranslationDnsRewriteArgs.builder()
                    .direction("reverse")
                    .build())
                .build())
            .build());

        // Define the data source (the item to be retrieved via API GET)
        final var dnatExternalWebTestGet = ScmFunctions.getNatRule(GetNatRuleArgs.builder()
            .id(dnatExternalWebTestCreate.id())
            .build());

        ctx.export("retrievedIDAndName", Map.ofEntries(
            Map.entry("id", dnatExternalWebTestGet.applyValue(_dnatExternalWebTestGet -> _dnatExternalWebTestGet.id())),
            Map.entry("name", dnatExternalWebTestGet.applyValue(_dnatExternalWebTestGet -> _dnatExternalWebTestGet.name()))
        ));
        ctx.export("retrievedDestinationTranslation", dnatExternalWebTestGet.applyValue(_dnatExternalWebTestGet -> _dnatExternalWebTestGet.destinationTranslation()));
        ctx.export("recievedResponse", dnatExternalWebTestGet);
    }
}

resources:
  # Define the resource (the item to be created via API POST/PUT)
  dnatExternalWebTestCreate:
    type: scm:NatRule
    name: dnat_external_web_test_create
    properties:
      name: DNAT-External-data-src-test_1
      description: Translate public VIP to internal web server.
      froms:
        - zone-untrust
      tos:
        - zone-untrust
      sources:
        - any
      destinations:
        - any
      service: service-http
      folder: All
      natType: ipv4
      position: pre
      destinationTranslation:
        translatedAddress: 10.1.1.16
        translatedPort: 112
        dnsRewrite:
          direction: reverse
variables:
  # Define the data source (the item to be retrieved via API GET)
  dnatExternalWebTestGet:
    fn::invoke:
      function: scm:getNatRule
      arguments:
        id: ${dnatExternalWebTestCreate.id}
outputs:
  # --- Output Blocks to Print Retrieved Data ---
  retrievedIDAndName:
    id: ${dnatExternalWebTestGet.id}
    name: ${dnatExternalWebTestGet.name}
  retrievedDestinationTranslation: ${dnatExternalWebTestGet.destinationTranslation}
  recievedResponse: ${dnatExternalWebTestGet}

Using getNatRule

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 getNatRule(args: GetNatRuleArgs, opts?: InvokeOptions): Promise<GetNatRuleResult>
function getNatRuleOutput(args: GetNatRuleOutputArgs, opts?: InvokeOptions): Output<GetNatRuleResult>

def get_nat_rule(id: Optional[str] = None,
                 name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetNatRuleResult
def get_nat_rule_output(id: Optional[pulumi.Input[str]] = None,
                 name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetNatRuleResult]

func LookupNatRule(ctx *Context, args *LookupNatRuleArgs, opts ...InvokeOption) (*LookupNatRuleResult, error)
func LookupNatRuleOutput(ctx *Context, args *LookupNatRuleOutputArgs, opts ...InvokeOption) LookupNatRuleResultOutput

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

public static class GetNatRule 
{
    public static Task<GetNatRuleResult> InvokeAsync(GetNatRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetNatRuleResult> Invoke(GetNatRuleInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetNatRuleResult> getNatRule(GetNatRuleArgs args, InvokeOptions options)
public static Output<GetNatRuleResult> getNatRule(GetNatRuleArgs args, InvokeOptions options)

fn::invoke:
  function: scm:index/getNatRule:getNatRule
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: UUID of the resource
Name string: NAT rule name

Id string: UUID of the resource
Name string: NAT rule name

id String: UUID of the resource
name String: NAT rule name

id string: UUID of the resource
name string: NAT rule name

id str: UUID of the resource
name str: NAT rule name

id String: UUID of the resource
name String: NAT rule name

getNatRule Result

The following output properties are available:

ActiveActiveDeviceBinding string: Active active device binding
Description string: NAT rule description
DestinationTranslation GetNatRuleDestinationTranslation: Destination translation
Destinations List<string>: Destination address(es) of the original packet
Device string: The device in which the resource is defined
Disabled bool: Disable NAT rule?
DynamicDestinationTranslation GetNatRuleDynamicDestinationTranslation: Dynamic destination translation
Folder string: The folder in which the resource is defined
Froms List<string>: Source zone(s) of the original packet
Id string: UUID of the resource
Name string: NAT rule name
NatType string: NAT type
Position string: The relative position of the rule
Service string: The service of the original packet
Snippet string: The snippet in which the resource is defined
SourceTranslation GetNatRuleSourceTranslation: Source translation
Sources List<string>: Source address(es) of the original packet
Tags List<string>: NAT rule tags
Tfid string
ToInterface string: Destination interface of the original packet
Tos List<string>: Destination zone of the original packet

ActiveActiveDeviceBinding string: Active active device binding
Description string: NAT rule description
DestinationTranslation GetNatRuleDestinationTranslation: Destination translation
Destinations []string: Destination address(es) of the original packet
Device string: The device in which the resource is defined
Disabled bool: Disable NAT rule?
DynamicDestinationTranslation GetNatRuleDynamicDestinationTranslation: Dynamic destination translation
Folder string: The folder in which the resource is defined
Froms []string: Source zone(s) of the original packet
Id string: UUID of the resource
Name string: NAT rule name
NatType string: NAT type
Position string: The relative position of the rule
Service string: The service of the original packet
Snippet string: The snippet in which the resource is defined
SourceTranslation GetNatRuleSourceTranslation: Source translation
Sources []string: Source address(es) of the original packet
Tags []string: NAT rule tags
Tfid string
ToInterface string: Destination interface of the original packet
Tos []string: Destination zone of the original packet

activeActiveDeviceBinding String: Active active device binding
description String: NAT rule description
destinationTranslation GetNatRuleDestinationTranslation: Destination translation
destinations List<String>: Destination address(es) of the original packet
device String: The device in which the resource is defined
disabled Boolean: Disable NAT rule?
dynamicDestinationTranslation GetNatRuleDynamicDestinationTranslation: Dynamic destination translation
folder String: The folder in which the resource is defined
froms List<String>: Source zone(s) of the original packet
id String: UUID of the resource
name String: NAT rule name
natType String: NAT type
position String: The relative position of the rule
service String: The service of the original packet
snippet String: The snippet in which the resource is defined
sourceTranslation GetNatRuleSourceTranslation: Source translation
sources List<String>: Source address(es) of the original packet
tags List<String>: NAT rule tags
tfid String
toInterface String: Destination interface of the original packet
tos List<String>: Destination zone of the original packet

activeActiveDeviceBinding string: Active active device binding
description string: NAT rule description
destinationTranslation GetNatRuleDestinationTranslation: Destination translation
destinations string[]: Destination address(es) of the original packet
device string: The device in which the resource is defined
disabled boolean: Disable NAT rule?
dynamicDestinationTranslation GetNatRuleDynamicDestinationTranslation: Dynamic destination translation
folder string: The folder in which the resource is defined
froms string[]: Source zone(s) of the original packet
id string: UUID of the resource
name string: NAT rule name
natType string: NAT type
position string: The relative position of the rule
service string: The service of the original packet
snippet string: The snippet in which the resource is defined
sourceTranslation GetNatRuleSourceTranslation: Source translation
sources string[]: Source address(es) of the original packet
tags string[]: NAT rule tags
tfid string
toInterface string: Destination interface of the original packet
tos string[]: Destination zone of the original packet

active_active_device_binding str: Active active device binding
description str: NAT rule description
destination_translation GetNatRuleDestinationTranslation: Destination translation
destinations Sequence[str]: Destination address(es) of the original packet
device str: The device in which the resource is defined
disabled bool: Disable NAT rule?
dynamic_destination_translation GetNatRuleDynamicDestinationTranslation: Dynamic destination translation
folder str: The folder in which the resource is defined
froms Sequence[str]: Source zone(s) of the original packet
id str: UUID of the resource
name str: NAT rule name
nat_type str: NAT type
position str: The relative position of the rule
service str: The service of the original packet
snippet str: The snippet in which the resource is defined
source_translation GetNatRuleSourceTranslation: Source translation
sources Sequence[str]: Source address(es) of the original packet
tags Sequence[str]: NAT rule tags
tfid str
to_interface str: Destination interface of the original packet
tos Sequence[str]: Destination zone of the original packet