1. Packages
  2. Strata Cloud Manager Provider
  3. API Docs
  4. NatRule
Strata Cloud Manager v0.3.1 published on Thursday, Mar 13, 2025 by Pulumi

scm.NatRule

Explore with Pulumi AI

Retrieves a config item.

Example Usage

Coming soon!
Coming soon!
Coming soon!
Coming soon!
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.NatRuleSourceTranslationArgs;
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 example = new NatRule("example", NatRuleArgs.builder()
            .folder("folder1")
            .name("example_nat1")
            .description("Example source nat")
            .sources("10.10.10.10/24")
            .froms("any")
            .tos("untrust")
            .sourceTranslation(NatRuleSourceTranslationArgs.builder()
                .translated_address_single("192.168.10.100")
                .bi_directional("no")
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: scm:NatRule
    properties:
      folder: folder1
      name: example_nat1
      description: Example source nat
      sources:
        - 10.10.10.10/24
      froms:
        - any
      tos:
        - untrust
      sourceTranslation:
        translated_address_single: 192.168.10.100
        bi_directional: no
Copy

Create NatRule Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new NatRule(name: string, args: NatRuleArgs, opts?: CustomResourceOptions);
@overload
def NatRule(resource_name: str,
            args: NatRuleArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def NatRule(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            froms: Optional[Sequence[str]] = None,
            tos: Optional[Sequence[str]] = None,
            sources: Optional[Sequence[str]] = None,
            destinations: Optional[Sequence[str]] = None,
            service: Optional[str] = None,
            name: Optional[str] = None,
            position: Optional[str] = None,
            folder: Optional[str] = None,
            disabled: Optional[bool] = None,
            group_tag: Optional[str] = None,
            active_active_device_binding: Optional[str] = None,
            nat_type: Optional[str] = None,
            dynamic_destination_translation: Optional[NatRuleDynamicDestinationTranslationArgs] = None,
            device: Optional[str] = None,
            snippet: Optional[str] = None,
            source_translation: Optional[NatRuleSourceTranslationArgs] = None,
            destination_translation: Optional[NatRuleDestinationTranslationArgs] = None,
            tags: Optional[Sequence[str]] = None,
            target: Optional[NatRuleTargetArgs] = None,
            to_interface: Optional[str] = None,
            description: Optional[str] = None)
func NewNatRule(ctx *Context, name string, args NatRuleArgs, opts ...ResourceOption) (*NatRule, error)
public NatRule(string name, NatRuleArgs args, CustomResourceOptions? opts = null)
public NatRule(String name, NatRuleArgs args)
public NatRule(String name, NatRuleArgs args, CustomResourceOptions options)
type: scm:NatRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. NatRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. NatRuleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. NatRuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. NatRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. NatRuleArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var natRuleResource = new Scm.NatRule("natRuleResource", new()
{
    Froms = new[]
    {
        "string",
    },
    Tos = new[]
    {
        "string",
    },
    Sources = new[]
    {
        "string",
    },
    Destinations = new[]
    {
        "string",
    },
    Service = "string",
    Name = "string",
    Position = "string",
    Folder = "string",
    Disabled = false,
    GroupTag = "string",
    ActiveActiveDeviceBinding = "string",
    NatType = "string",
    DynamicDestinationTranslation = new Scm.Inputs.NatRuleDynamicDestinationTranslationArgs
    {
        TranslatedAddressSingle = "string",
        Distribution = "string",
        TranslatedPort = 0,
    },
    Device = "string",
    Snippet = "string",
    SourceTranslation = new Scm.Inputs.NatRuleSourceTranslationArgs
    {
        BiDirectional = "string",
        Fallback = new Scm.Inputs.NatRuleSourceTranslationFallbackArgs
        {
            Interface = "string",
        },
        TranslatedAddressArrays = new[]
        {
            "string",
        },
        TranslatedAddressSingle = "string",
    },
    DestinationTranslation = new Scm.Inputs.NatRuleDestinationTranslationArgs
    {
        TranslatedAddressSingle = "string",
        DnsRewrite = new Scm.Inputs.NatRuleDestinationTranslationDnsRewriteArgs
        {
            Direction = "string",
        },
        TranslatedPort = 0,
    },
    Tags = new[]
    {
        "string",
    },
    Target = new Scm.Inputs.NatRuleTargetArgs
    {
        Devices = new[]
        {
            new Scm.Inputs.NatRuleTargetDeviceArgs
            {
                Name = "string",
            },
        },
        Negate = false,
        Tags = new[]
        {
            "string",
        },
    },
    ToInterface = "string",
    Description = "string",
});
Copy
example, err := scm.NewNatRule(ctx, "natRuleResource", &scm.NatRuleArgs{
	Froms: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tos: pulumi.StringArray{
		pulumi.String("string"),
	},
	Sources: pulumi.StringArray{
		pulumi.String("string"),
	},
	Destinations: pulumi.StringArray{
		pulumi.String("string"),
	},
	Service:                   pulumi.String("string"),
	Name:                      pulumi.String("string"),
	Position:                  pulumi.String("string"),
	Folder:                    pulumi.String("string"),
	Disabled:                  pulumi.Bool(false),
	GroupTag:                  pulumi.String("string"),
	ActiveActiveDeviceBinding: pulumi.String("string"),
	NatType:                   pulumi.String("string"),
	DynamicDestinationTranslation: &scm.NatRuleDynamicDestinationTranslationArgs{
		TranslatedAddressSingle: pulumi.String("string"),
		Distribution:            pulumi.String("string"),
		TranslatedPort:          pulumi.Int(0),
	},
	Device:  pulumi.String("string"),
	Snippet: pulumi.String("string"),
	SourceTranslation: &scm.NatRuleSourceTranslationArgs{
		BiDirectional: pulumi.String("string"),
		Fallback: &scm.NatRuleSourceTranslationFallbackArgs{
			Interface: pulumi.String("string"),
		},
		TranslatedAddressArrays: pulumi.StringArray{
			pulumi.String("string"),
		},
		TranslatedAddressSingle: pulumi.String("string"),
	},
	DestinationTranslation: &scm.NatRuleDestinationTranslationArgs{
		TranslatedAddressSingle: pulumi.String("string"),
		DnsRewrite: &scm.NatRuleDestinationTranslationDnsRewriteArgs{
			Direction: pulumi.String("string"),
		},
		TranslatedPort: pulumi.Int(0),
	},
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Target: &scm.NatRuleTargetArgs{
		Devices: scm.NatRuleTargetDeviceArray{
			&scm.NatRuleTargetDeviceArgs{
				Name: pulumi.String("string"),
			},
		},
		Negate: pulumi.Bool(false),
		Tags: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	ToInterface: pulumi.String("string"),
	Description: pulumi.String("string"),
})
Copy
var natRuleResource = new NatRule("natRuleResource", NatRuleArgs.builder()
    .froms("string")
    .tos("string")
    .sources("string")
    .destinations("string")
    .service("string")
    .name("string")
    .position("string")
    .folder("string")
    .disabled(false)
    .groupTag("string")
    .activeActiveDeviceBinding("string")
    .natType("string")
    .dynamicDestinationTranslation(NatRuleDynamicDestinationTranslationArgs.builder()
        .translatedAddressSingle("string")
        .distribution("string")
        .translatedPort(0)
        .build())
    .device("string")
    .snippet("string")
    .sourceTranslation(NatRuleSourceTranslationArgs.builder()
        .biDirectional("string")
        .fallback(NatRuleSourceTranslationFallbackArgs.builder()
            .interface_("string")
            .build())
        .translatedAddressArrays("string")
        .translatedAddressSingle("string")
        .build())
    .destinationTranslation(NatRuleDestinationTranslationArgs.builder()
        .translatedAddressSingle("string")
        .dnsRewrite(NatRuleDestinationTranslationDnsRewriteArgs.builder()
            .direction("string")
            .build())
        .translatedPort(0)
        .build())
    .tags("string")
    .target(NatRuleTargetArgs.builder()
        .devices(NatRuleTargetDeviceArgs.builder()
            .name("string")
            .build())
        .negate(false)
        .tags("string")
        .build())
    .toInterface("string")
    .description("string")
    .build());
Copy
nat_rule_resource = scm.NatRule("natRuleResource",
    froms=["string"],
    tos=["string"],
    sources=["string"],
    destinations=["string"],
    service="string",
    name="string",
    position="string",
    folder="string",
    disabled=False,
    group_tag="string",
    active_active_device_binding="string",
    nat_type="string",
    dynamic_destination_translation={
        "translated_address_single": "string",
        "distribution": "string",
        "translated_port": 0,
    },
    device="string",
    snippet="string",
    source_translation={
        "bi_directional": "string",
        "fallback": {
            "interface": "string",
        },
        "translated_address_arrays": ["string"],
        "translated_address_single": "string",
    },
    destination_translation={
        "translated_address_single": "string",
        "dns_rewrite": {
            "direction": "string",
        },
        "translated_port": 0,
    },
    tags=["string"],
    target={
        "devices": [{
            "name": "string",
        }],
        "negate": False,
        "tags": ["string"],
    },
    to_interface="string",
    description="string")
Copy
const natRuleResource = new scm.NatRule("natRuleResource", {
    froms: ["string"],
    tos: ["string"],
    sources: ["string"],
    destinations: ["string"],
    service: "string",
    name: "string",
    position: "string",
    folder: "string",
    disabled: false,
    groupTag: "string",
    activeActiveDeviceBinding: "string",
    natType: "string",
    dynamicDestinationTranslation: {
        translatedAddressSingle: "string",
        distribution: "string",
        translatedPort: 0,
    },
    device: "string",
    snippet: "string",
    sourceTranslation: {
        biDirectional: "string",
        fallback: {
            "interface": "string",
        },
        translatedAddressArrays: ["string"],
        translatedAddressSingle: "string",
    },
    destinationTranslation: {
        translatedAddressSingle: "string",
        dnsRewrite: {
            direction: "string",
        },
        translatedPort: 0,
    },
    tags: ["string"],
    target: {
        devices: [{
            name: "string",
        }],
        negate: false,
        tags: ["string"],
    },
    toInterface: "string",
    description: "string",
});
Copy
type: scm:NatRule
properties:
    activeActiveDeviceBinding: string
    description: string
    destinationTranslation:
        dnsRewrite:
            direction: string
        translatedAddressSingle: string
        translatedPort: 0
    destinations:
        - string
    device: string
    disabled: false
    dynamicDestinationTranslation:
        distribution: string
        translatedAddressSingle: string
        translatedPort: 0
    folder: string
    froms:
        - string
    groupTag: string
    name: string
    natType: string
    position: string
    service: string
    snippet: string
    sourceTranslation:
        biDirectional: string
        fallback:
            interface: string
        translatedAddressArrays:
            - string
        translatedAddressSingle: string
    sources:
        - string
    tags:
        - string
    target:
        devices:
            - name: string
        negate: false
        tags:
            - string
    toInterface: string
    tos:
        - string
Copy

NatRule Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The NatRule resource accepts the following input properties:

Destinations This property is required. List<string>
The destination address(es). Individual elements in this list are subject to additional validation. String must be one of these: "any".
Froms This property is required. List<string>
The source security zone(s). Individual elements in this list are subject to additional validation. String must be one of these: "any".
Service This property is required. string
The Service param.
Sources This property is required. List<string>
The source address(es). Individual elements in this list are subject to additional validation. String must be one of these: "any".
Tos This property is required. List<string>
The destination security zone(s).
ActiveActiveDeviceBinding string
The ActiveActiveDeviceBinding param. String must be one of these: "primary", "both", "0", "1".
Description string
The Description param.
DestinationTranslation NatRuleDestinationTranslation
Static destination translation parameter.
Device string
The device in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
Disabled bool
The Disabled param.
DynamicDestinationTranslation NatRuleDynamicDestinationTranslation
Dynamic destination translation parameter.
Folder string
The folder in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
GroupTag string
The GroupTag param.
Name string
The Name param.
NatType string
The NatType param. String must be one of these: "ipv4", "nat64", "nptv6".
Position string
The Position param. String must be one of these: "pre", "post". Default: "pre".
Snippet string
The snippet in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
SourceTranslation NatRuleSourceTranslation
The SourceTranslation param.
Tags List<string>
The Tags param.
Target NatRuleTarget
The Target param.
ToInterface string
The ToInterface param. String must be one of these: "any".
Destinations This property is required. []string
The destination address(es). Individual elements in this list are subject to additional validation. String must be one of these: "any".
Froms This property is required. []string
The source security zone(s). Individual elements in this list are subject to additional validation. String must be one of these: "any".
Service This property is required. string
The Service param.
Sources This property is required. []string
The source address(es). Individual elements in this list are subject to additional validation. String must be one of these: "any".
Tos This property is required. []string
The destination security zone(s).
ActiveActiveDeviceBinding string
The ActiveActiveDeviceBinding param. String must be one of these: "primary", "both", "0", "1".
Description string
The Description param.
DestinationTranslation NatRuleDestinationTranslationArgs
Static destination translation parameter.
Device string
The device in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
Disabled bool
The Disabled param.
DynamicDestinationTranslation NatRuleDynamicDestinationTranslationArgs
Dynamic destination translation parameter.
Folder string
The folder in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
GroupTag string
The GroupTag param.
Name string
The Name param.
NatType string
The NatType param. String must be one of these: "ipv4", "nat64", "nptv6".
Position string
The Position param. String must be one of these: "pre", "post". Default: "pre".
Snippet string
The snippet in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
SourceTranslation NatRuleSourceTranslationArgs
The SourceTranslation param.
Tags []string
The Tags param.
Target NatRuleTargetArgs
The Target param.
ToInterface string
The ToInterface param. String must be one of these: "any".
destinations This property is required. List<String>
The destination address(es). Individual elements in this list are subject to additional validation. String must be one of these: "any".
froms This property is required. List<String>
The source security zone(s). Individual elements in this list are subject to additional validation. String must be one of these: "any".
service This property is required. String
The Service param.
sources This property is required. List<String>
The source address(es). Individual elements in this list are subject to additional validation. String must be one of these: "any".
tos This property is required. List<String>
The destination security zone(s).
activeActiveDeviceBinding String
The ActiveActiveDeviceBinding param. String must be one of these: "primary", "both", "0", "1".
description String
The Description param.
destinationTranslation NatRuleDestinationTranslation
Static destination translation parameter.
device String
The device in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
disabled Boolean
The Disabled param.
dynamicDestinationTranslation NatRuleDynamicDestinationTranslation
Dynamic destination translation parameter.
folder String
The folder in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
groupTag String
The GroupTag param.
name String
The Name param.
natType String
The NatType param. String must be one of these: "ipv4", "nat64", "nptv6".
position String
The Position param. String must be one of these: "pre", "post". Default: "pre".
snippet String
The snippet in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
sourceTranslation NatRuleSourceTranslation
The SourceTranslation param.
tags List<String>
The Tags param.
target NatRuleTarget
The Target param.
toInterface String
The ToInterface param. String must be one of these: "any".
destinations This property is required. string[]
The destination address(es). Individual elements in this list are subject to additional validation. String must be one of these: "any".
froms This property is required. string[]
The source security zone(s). Individual elements in this list are subject to additional validation. String must be one of these: "any".
service This property is required. string
The Service param.
sources This property is required. string[]
The source address(es). Individual elements in this list are subject to additional validation. String must be one of these: "any".
tos This property is required. string[]
The destination security zone(s).
activeActiveDeviceBinding string
The ActiveActiveDeviceBinding param. String must be one of these: "primary", "both", "0", "1".
description string
The Description param.
destinationTranslation NatRuleDestinationTranslation
Static destination translation parameter.
device string
The device in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
disabled boolean
The Disabled param.
dynamicDestinationTranslation NatRuleDynamicDestinationTranslation
Dynamic destination translation parameter.
folder string
The folder in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
groupTag string
The GroupTag param.
name string
The Name param.
natType string
The NatType param. String must be one of these: "ipv4", "nat64", "nptv6".
position string
The Position param. String must be one of these: "pre", "post". Default: "pre".
snippet string
The snippet in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
sourceTranslation NatRuleSourceTranslation
The SourceTranslation param.
tags string[]
The Tags param.
target NatRuleTarget
The Target param.
toInterface string
The ToInterface param. String must be one of these: "any".
destinations This property is required. Sequence[str]
The destination address(es). Individual elements in this list are subject to additional validation. String must be one of these: "any".
froms This property is required. Sequence[str]
The source security zone(s). Individual elements in this list are subject to additional validation. String must be one of these: "any".
service This property is required. str
The Service param.
sources This property is required. Sequence[str]
The source address(es). Individual elements in this list are subject to additional validation. String must be one of these: "any".
tos This property is required. Sequence[str]
The destination security zone(s).
active_active_device_binding str
The ActiveActiveDeviceBinding param. String must be one of these: "primary", "both", "0", "1".
description str
The Description param.
destination_translation NatRuleDestinationTranslationArgs
Static destination translation parameter.
device str
The device in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
disabled bool
The Disabled param.
dynamic_destination_translation NatRuleDynamicDestinationTranslationArgs
Dynamic destination translation parameter.
folder str
The folder in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
group_tag str
The GroupTag param.
name str
The Name param.
nat_type str
The NatType param. String must be one of these: "ipv4", "nat64", "nptv6".
position str
The Position param. String must be one of these: "pre", "post". Default: "pre".
snippet str
The snippet in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
source_translation NatRuleSourceTranslationArgs
The SourceTranslation param.
tags Sequence[str]
The Tags param.
target NatRuleTargetArgs
The Target param.
to_interface str
The ToInterface param. String must be one of these: "any".
destinations This property is required. List<String>
The destination address(es). Individual elements in this list are subject to additional validation. String must be one of these: "any".
froms This property is required. List<String>
The source security zone(s). Individual elements in this list are subject to additional validation. String must be one of these: "any".
service This property is required. String
The Service param.
sources This property is required. List<String>
The source address(es). Individual elements in this list are subject to additional validation. String must be one of these: "any".
tos This property is required. List<String>
The destination security zone(s).
activeActiveDeviceBinding String
The ActiveActiveDeviceBinding param. String must be one of these: "primary", "both", "0", "1".
description String
The Description param.
destinationTranslation Property Map
Static destination translation parameter.
device String
The device in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
disabled Boolean
The Disabled param.
dynamicDestinationTranslation Property Map
Dynamic destination translation parameter.
folder String
The folder in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
groupTag String
The GroupTag param.
name String
The Name param.
natType String
The NatType param. String must be one of these: "ipv4", "nat64", "nptv6".
position String
The Position param. String must be one of these: "pre", "post". Default: "pre".
snippet String
The snippet in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
sourceTranslation Property Map
The SourceTranslation param.
tags List<String>
The Tags param.
target Property Map
The Target param.
toInterface String
The ToInterface param. String must be one of these: "any".

Outputs

All input properties are implicitly available as output properties. Additionally, the NatRule resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Tfid string
Id string
The provider-assigned unique ID for this managed resource.
Tfid string
id String
The provider-assigned unique ID for this managed resource.
tfid String
id string
The provider-assigned unique ID for this managed resource.
tfid string
id str
The provider-assigned unique ID for this managed resource.
tfid str
id String
The provider-assigned unique ID for this managed resource.
tfid String

Look up Existing NatRule Resource

Get an existing NatRule 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?: NatRuleState, opts?: CustomResourceOptions): NatRule
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active_active_device_binding: Optional[str] = None,
        description: Optional[str] = None,
        destination_translation: Optional[NatRuleDestinationTranslationArgs] = None,
        destinations: Optional[Sequence[str]] = None,
        device: Optional[str] = None,
        disabled: Optional[bool] = None,
        dynamic_destination_translation: Optional[NatRuleDynamicDestinationTranslationArgs] = None,
        folder: Optional[str] = None,
        froms: Optional[Sequence[str]] = None,
        group_tag: Optional[str] = None,
        name: Optional[str] = None,
        nat_type: Optional[str] = None,
        position: Optional[str] = None,
        service: Optional[str] = None,
        snippet: Optional[str] = None,
        source_translation: Optional[NatRuleSourceTranslationArgs] = None,
        sources: Optional[Sequence[str]] = None,
        tags: Optional[Sequence[str]] = None,
        target: Optional[NatRuleTargetArgs] = None,
        tfid: Optional[str] = None,
        to_interface: Optional[str] = None,
        tos: Optional[Sequence[str]] = None) -> NatRule
func GetNatRule(ctx *Context, name string, id IDInput, state *NatRuleState, opts ...ResourceOption) (*NatRule, error)
public static NatRule Get(string name, Input<string> id, NatRuleState? state, CustomResourceOptions? opts = null)
public static NatRule get(String name, Output<String> id, NatRuleState state, CustomResourceOptions options)
resources:  _:    type: scm:NatRule    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ActiveActiveDeviceBinding string
The ActiveActiveDeviceBinding param. String must be one of these: "primary", "both", "0", "1".
Description string
The Description param.
DestinationTranslation NatRuleDestinationTranslation
Static destination translation parameter.
Destinations List<string>
The destination address(es). Individual elements in this list are subject to additional validation. String must be one of these: "any".
Device string
The device in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
Disabled bool
The Disabled param.
DynamicDestinationTranslation NatRuleDynamicDestinationTranslation
Dynamic destination translation parameter.
Folder string
The folder in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
Froms List<string>
The source security zone(s). Individual elements in this list are subject to additional validation. String must be one of these: "any".
GroupTag string
The GroupTag param.
Name string
The Name param.
NatType string
The NatType param. String must be one of these: "ipv4", "nat64", "nptv6".
Position string
The Position param. String must be one of these: "pre", "post". Default: "pre".
Service string
The Service param.
Snippet string
The snippet in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
SourceTranslation NatRuleSourceTranslation
The SourceTranslation param.
Sources List<string>
The source address(es). Individual elements in this list are subject to additional validation. String must be one of these: "any".
Tags List<string>
The Tags param.
Target NatRuleTarget
The Target param.
Tfid string
ToInterface string
The ToInterface param. String must be one of these: "any".
Tos List<string>
The destination security zone(s).
ActiveActiveDeviceBinding string
The ActiveActiveDeviceBinding param. String must be one of these: "primary", "both", "0", "1".
Description string
The Description param.
DestinationTranslation NatRuleDestinationTranslationArgs
Static destination translation parameter.
Destinations []string
The destination address(es). Individual elements in this list are subject to additional validation. String must be one of these: "any".
Device string
The device in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
Disabled bool
The Disabled param.
DynamicDestinationTranslation NatRuleDynamicDestinationTranslationArgs
Dynamic destination translation parameter.
Folder string
The folder in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
Froms []string
The source security zone(s). Individual elements in this list are subject to additional validation. String must be one of these: "any".
GroupTag string
The GroupTag param.
Name string
The Name param.
NatType string
The NatType param. String must be one of these: "ipv4", "nat64", "nptv6".
Position string
The Position param. String must be one of these: "pre", "post". Default: "pre".
Service string
The Service param.
Snippet string
The snippet in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
SourceTranslation NatRuleSourceTranslationArgs
The SourceTranslation param.
Sources []string
The source address(es). Individual elements in this list are subject to additional validation. String must be one of these: "any".
Tags []string
The Tags param.
Target NatRuleTargetArgs
The Target param.
Tfid string
ToInterface string
The ToInterface param. String must be one of these: "any".
Tos []string
The destination security zone(s).
activeActiveDeviceBinding String
The ActiveActiveDeviceBinding param. String must be one of these: "primary", "both", "0", "1".
description String
The Description param.
destinationTranslation NatRuleDestinationTranslation
Static destination translation parameter.
destinations List<String>
The destination address(es). Individual elements in this list are subject to additional validation. String must be one of these: "any".
device String
The device in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
disabled Boolean
The Disabled param.
dynamicDestinationTranslation NatRuleDynamicDestinationTranslation
Dynamic destination translation parameter.
folder String
The folder in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
froms List<String>
The source security zone(s). Individual elements in this list are subject to additional validation. String must be one of these: "any".
groupTag String
The GroupTag param.
name String
The Name param.
natType String
The NatType param. String must be one of these: "ipv4", "nat64", "nptv6".
position String
The Position param. String must be one of these: "pre", "post". Default: "pre".
service String
The Service param.
snippet String
The snippet in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
sourceTranslation NatRuleSourceTranslation
The SourceTranslation param.
sources List<String>
The source address(es). Individual elements in this list are subject to additional validation. String must be one of these: "any".
tags List<String>
The Tags param.
target NatRuleTarget
The Target param.
tfid String
toInterface String
The ToInterface param. String must be one of these: "any".
tos List<String>
The destination security zone(s).
activeActiveDeviceBinding string
The ActiveActiveDeviceBinding param. String must be one of these: "primary", "both", "0", "1".
description string
The Description param.
destinationTranslation NatRuleDestinationTranslation
Static destination translation parameter.
destinations string[]
The destination address(es). Individual elements in this list are subject to additional validation. String must be one of these: "any".
device string
The device in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
disabled boolean
The Disabled param.
dynamicDestinationTranslation NatRuleDynamicDestinationTranslation
Dynamic destination translation parameter.
folder string
The folder in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
froms string[]
The source security zone(s). Individual elements in this list are subject to additional validation. String must be one of these: "any".
groupTag string
The GroupTag param.
name string
The Name param.
natType string
The NatType param. String must be one of these: "ipv4", "nat64", "nptv6".
position string
The Position param. String must be one of these: "pre", "post". Default: "pre".
service string
The Service param.
snippet string
The snippet in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
sourceTranslation NatRuleSourceTranslation
The SourceTranslation param.
sources string[]
The source address(es). Individual elements in this list are subject to additional validation. String must be one of these: "any".
tags string[]
The Tags param.
target NatRuleTarget
The Target param.
tfid string
toInterface string
The ToInterface param. String must be one of these: "any".
tos string[]
The destination security zone(s).
active_active_device_binding str
The ActiveActiveDeviceBinding param. String must be one of these: "primary", "both", "0", "1".
description str
The Description param.
destination_translation NatRuleDestinationTranslationArgs
Static destination translation parameter.
destinations Sequence[str]
The destination address(es). Individual elements in this list are subject to additional validation. String must be one of these: "any".
device str
The device in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
disabled bool
The Disabled param.
dynamic_destination_translation NatRuleDynamicDestinationTranslationArgs
Dynamic destination translation parameter.
folder str
The folder in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
froms Sequence[str]
The source security zone(s). Individual elements in this list are subject to additional validation. String must be one of these: "any".
group_tag str
The GroupTag param.
name str
The Name param.
nat_type str
The NatType param. String must be one of these: "ipv4", "nat64", "nptv6".
position str
The Position param. String must be one of these: "pre", "post". Default: "pre".
service str
The Service param.
snippet str
The snippet in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
source_translation NatRuleSourceTranslationArgs
The SourceTranslation param.
sources Sequence[str]
The source address(es). Individual elements in this list are subject to additional validation. String must be one of these: "any".
tags Sequence[str]
The Tags param.
target NatRuleTargetArgs
The Target param.
tfid str
to_interface str
The ToInterface param. String must be one of these: "any".
tos Sequence[str]
The destination security zone(s).
activeActiveDeviceBinding String
The ActiveActiveDeviceBinding param. String must be one of these: "primary", "both", "0", "1".
description String
The Description param.
destinationTranslation Property Map
Static destination translation parameter.
destinations List<String>
The destination address(es). Individual elements in this list are subject to additional validation. String must be one of these: "any".
device String
The device in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
disabled Boolean
The Disabled param.
dynamicDestinationTranslation Property Map
Dynamic destination translation parameter.
folder String
The folder in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
froms List<String>
The source security zone(s). Individual elements in this list are subject to additional validation. String must be one of these: "any".
groupTag String
The GroupTag param.
name String
The Name param.
natType String
The NatType param. String must be one of these: "ipv4", "nat64", "nptv6".
position String
The Position param. String must be one of these: "pre", "post". Default: "pre".
service String
The Service param.
snippet String
The snippet in which the resource is defined. String length must not exceed 64 characters. String validation regex: ^[a-zA-Z\d-_\. ]+$.
sourceTranslation Property Map
The SourceTranslation param.
sources List<String>
The source address(es). Individual elements in this list are subject to additional validation. String must be one of these: "any".
tags List<String>
The Tags param.
target Property Map
The Target param.
tfid String
toInterface String
The ToInterface param. String must be one of these: "any".
tos List<String>
The destination security zone(s).

Supporting Types

NatRuleDestinationTranslation
, NatRuleDestinationTranslationArgs

TranslatedAddressSingle This property is required. string
The ip address to be translated. String validation regex: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}$.
DnsRewrite NatRuleDestinationTranslationDnsRewrite
The DnsRewrite param.
TranslatedPort int
The TranslatedPort param.
TranslatedAddressSingle This property is required. string
The ip address to be translated. String validation regex: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}$.
DnsRewrite NatRuleDestinationTranslationDnsRewrite
The DnsRewrite param.
TranslatedPort int
The TranslatedPort param.
translatedAddressSingle This property is required. String
The ip address to be translated. String validation regex: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}$.
dnsRewrite NatRuleDestinationTranslationDnsRewrite
The DnsRewrite param.
translatedPort Integer
The TranslatedPort param.
translatedAddressSingle This property is required. string
The ip address to be translated. String validation regex: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}$.
dnsRewrite NatRuleDestinationTranslationDnsRewrite
The DnsRewrite param.
translatedPort number
The TranslatedPort param.
translated_address_single This property is required. str
The ip address to be translated. String validation regex: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}$.
dns_rewrite NatRuleDestinationTranslationDnsRewrite
The DnsRewrite param.
translated_port int
The TranslatedPort param.
translatedAddressSingle This property is required. String
The ip address to be translated. String validation regex: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}$.
dnsRewrite Property Map
The DnsRewrite param.
translatedPort Number
The TranslatedPort param.

NatRuleDestinationTranslationDnsRewrite
, NatRuleDestinationTranslationDnsRewriteArgs

Direction string
The Direction param. String must be one of these: "reverse", "forward". Default: "reverse".
Direction string
The Direction param. String must be one of these: "reverse", "forward". Default: "reverse".
direction String
The Direction param. String must be one of these: "reverse", "forward". Default: "reverse".
direction string
The Direction param. String must be one of these: "reverse", "forward". Default: "reverse".
direction str
The Direction param. String must be one of these: "reverse", "forward". Default: "reverse".
direction String
The Direction param. String must be one of these: "reverse", "forward". Default: "reverse".

NatRuleDynamicDestinationTranslation
, NatRuleDynamicDestinationTranslationArgs

TranslatedAddressSingle This property is required. string
The ip address to be translated. String validation regex: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}$.
Distribution string
The Distribution param. String must be one of these: "round-robin", "source-ip-hash", "ip-modulo", "ip-hash", "least-sessions". Default: "round-robin".
TranslatedPort int
The TranslatedPort param.
TranslatedAddressSingle This property is required. string
The ip address to be translated. String validation regex: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}$.
Distribution string
The Distribution param. String must be one of these: "round-robin", "source-ip-hash", "ip-modulo", "ip-hash", "least-sessions". Default: "round-robin".
TranslatedPort int
The TranslatedPort param.
translatedAddressSingle This property is required. String
The ip address to be translated. String validation regex: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}$.
distribution String
The Distribution param. String must be one of these: "round-robin", "source-ip-hash", "ip-modulo", "ip-hash", "least-sessions". Default: "round-robin".
translatedPort Integer
The TranslatedPort param.
translatedAddressSingle This property is required. string
The ip address to be translated. String validation regex: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}$.
distribution string
The Distribution param. String must be one of these: "round-robin", "source-ip-hash", "ip-modulo", "ip-hash", "least-sessions". Default: "round-robin".
translatedPort number
The TranslatedPort param.
translated_address_single This property is required. str
The ip address to be translated. String validation regex: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}$.
distribution str
The Distribution param. String must be one of these: "round-robin", "source-ip-hash", "ip-modulo", "ip-hash", "least-sessions". Default: "round-robin".
translated_port int
The TranslatedPort param.
translatedAddressSingle This property is required. String
The ip address to be translated. String validation regex: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}$.
distribution String
The Distribution param. String must be one of these: "round-robin", "source-ip-hash", "ip-modulo", "ip-hash", "least-sessions". Default: "round-robin".
translatedPort Number
The TranslatedPort param.

NatRuleSourceTranslation
, NatRuleSourceTranslationArgs

BiDirectional string
The BiDirectional param. String must be one of these: "yes", "no".
Fallback NatRuleSourceTranslationFallback
The Fallback param.
TranslatedAddressArrays List<string>
The TranslatedAddressArray param. Ensure that only one of the following is specified: translated_address_array, translated_address_single
TranslatedAddressSingle string
The TranslatedAddressSingle param. String validation regex: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}$. Ensure that only one of the following is specified: translated_address_array, translated_address_single
BiDirectional string
The BiDirectional param. String must be one of these: "yes", "no".
Fallback NatRuleSourceTranslationFallback
The Fallback param.
TranslatedAddressArrays []string
The TranslatedAddressArray param. Ensure that only one of the following is specified: translated_address_array, translated_address_single
TranslatedAddressSingle string
The TranslatedAddressSingle param. String validation regex: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}$. Ensure that only one of the following is specified: translated_address_array, translated_address_single
biDirectional String
The BiDirectional param. String must be one of these: "yes", "no".
fallback NatRuleSourceTranslationFallback
The Fallback param.
translatedAddressArrays List<String>
The TranslatedAddressArray param. Ensure that only one of the following is specified: translated_address_array, translated_address_single
translatedAddressSingle String
The TranslatedAddressSingle param. String validation regex: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}$. Ensure that only one of the following is specified: translated_address_array, translated_address_single
biDirectional string
The BiDirectional param. String must be one of these: "yes", "no".
fallback NatRuleSourceTranslationFallback
The Fallback param.
translatedAddressArrays string[]
The TranslatedAddressArray param. Ensure that only one of the following is specified: translated_address_array, translated_address_single
translatedAddressSingle string
The TranslatedAddressSingle param. String validation regex: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}$. Ensure that only one of the following is specified: translated_address_array, translated_address_single
bi_directional str
The BiDirectional param. String must be one of these: "yes", "no".
fallback NatRuleSourceTranslationFallback
The Fallback param.
translated_address_arrays Sequence[str]
The TranslatedAddressArray param. Ensure that only one of the following is specified: translated_address_array, translated_address_single
translated_address_single str
The TranslatedAddressSingle param. String validation regex: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}$. Ensure that only one of the following is specified: translated_address_array, translated_address_single
biDirectional String
The BiDirectional param. String must be one of these: "yes", "no".
fallback Property Map
The Fallback param.
translatedAddressArrays List<String>
The TranslatedAddressArray param. Ensure that only one of the following is specified: translated_address_array, translated_address_single
translatedAddressSingle String
The TranslatedAddressSingle param. String validation regex: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}$. Ensure that only one of the following is specified: translated_address_array, translated_address_single

NatRuleSourceTranslationFallback
, NatRuleSourceTranslationFallbackArgs

Interface string
The Interface param. Ensure that only one of the following is specified: interface
Interface string
The Interface param. Ensure that only one of the following is specified: interface
interface_ String
The Interface param. Ensure that only one of the following is specified: interface
interface string
The Interface param. Ensure that only one of the following is specified: interface
interface str
The Interface param. Ensure that only one of the following is specified: interface
interface String
The Interface param. Ensure that only one of the following is specified: interface

NatRuleTarget
, NatRuleTargetArgs

Devices List<NatRuleTargetDevice>
The Devices param.
Negate bool
The Negate param.
Tags List<string>
The Tags param.
Devices []NatRuleTargetDevice
The Devices param.
Negate bool
The Negate param.
Tags []string
The Tags param.
devices List<NatRuleTargetDevice>
The Devices param.
negate Boolean
The Negate param.
tags List<String>
The Tags param.
devices NatRuleTargetDevice[]
The Devices param.
negate boolean
The Negate param.
tags string[]
The Tags param.
devices Sequence[NatRuleTargetDevice]
The Devices param.
negate bool
The Negate param.
tags Sequence[str]
The Tags param.
devices List<Property Map>
The Devices param.
negate Boolean
The Negate param.
tags List<String>
The Tags param.

NatRuleTargetDevice
, NatRuleTargetDeviceArgs

Name string
The Name param.
Name string
The Name param.
name String
The Name param.
name string
The Name param.
name str
The Name param.
name String
The Name param.

Package Details

Repository
scm pulumi/pulumi-scm
License
Apache-2.0
Notes
This Pulumi package is based on the scm Terraform Provider.