Docs Home
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
avi.Natpolicy
Explore with Pulumi AI
<!–
Copyright 2021 VMware, Inc.
SPDX-License-Identifier: Mozilla Public License 2.0
–>
layout: “avi”
page_title: “Avi: avi.Natpolicy” sidebar_current: “docs-avi-resource-natpolicy” description: |- Creates and manages Avi NatPolicy.
avi.Natpolicy
The NatPolicy resource allows the creation and management of Avi NatPolicy
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as avi from "@pulumi/avi";
const foo = new avi.Natpolicy("foo", {tenantRef: "/api/tenant/?name=admin"});
import pulumi
import pulumi_avi as avi
foo = avi.Natpolicy("foo", tenant_ref="/api/tenant/?name=admin")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/avi/v31/avi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := avi.NewNatpolicy(ctx, "foo", &avi.NatpolicyArgs{
TenantRef: pulumi.String("/api/tenant/?name=admin"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Avi = Pulumi.Avi;
return await Deployment.RunAsync(() =>
{
var foo = new Avi.Natpolicy("foo", new()
{
TenantRef = "/api/tenant/?name=admin",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.Natpolicy;
import com.pulumi.avi.NatpolicyArgs;
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 foo = new Natpolicy("foo", NatpolicyArgs.builder()
.tenantRef("/api/tenant/?name=admin")
.build());
}
}
resources:
foo:
type: avi:Natpolicy
properties:
tenantRef: /api/tenant/?name=admin
Create Natpolicy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Natpolicy(name: string, args?: NatpolicyArgs, opts?: CustomResourceOptions);@overload
def Natpolicy(resource_name: str,
args: Optional[NatpolicyArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Natpolicy(resource_name: str,
opts: Optional[ResourceOptions] = None,
configpb_attributes: Optional[Sequence[NatpolicyConfigpbAttributeArgs]] = None,
created_by: Optional[str] = None,
description: Optional[str] = None,
markers: Optional[Sequence[NatpolicyMarkerArgs]] = None,
name: Optional[str] = None,
natpolicy_id: Optional[str] = None,
rules: Optional[Sequence[NatpolicyRuleArgs]] = None,
tenant_ref: Optional[str] = None,
uuid: Optional[str] = None)func NewNatpolicy(ctx *Context, name string, args *NatpolicyArgs, opts ...ResourceOption) (*Natpolicy, error)public Natpolicy(string name, NatpolicyArgs? args = null, CustomResourceOptions? opts = null)
public Natpolicy(String name, NatpolicyArgs args)
public Natpolicy(String name, NatpolicyArgs args, CustomResourceOptions options)
type: avi:Natpolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args NatpolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args NatpolicyArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args NatpolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args NatpolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args NatpolicyArgs
- 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 natpolicyResource = new Avi.Natpolicy("natpolicyResource", new()
{
ConfigpbAttributes = new[]
{
new Avi.Inputs.NatpolicyConfigpbAttributeArgs
{
Version = "string",
},
},
CreatedBy = "string",
Description = "string",
Markers = new[]
{
new Avi.Inputs.NatpolicyMarkerArgs
{
Key = "string",
Values = new[]
{
"string",
},
},
},
Name = "string",
NatpolicyId = "string",
Rules = new[]
{
new Avi.Inputs.NatpolicyRuleArgs
{
Actions = new[]
{
new Avi.Inputs.NatpolicyRuleActionArgs
{
Type = "string",
NatInfos = new[]
{
new Avi.Inputs.NatpolicyRuleActionNatInfoArgs
{
NatIpRanges = new[]
{
new Avi.Inputs.NatpolicyRuleActionNatInfoNatIpRangeArgs
{
Begins = new[]
{
new Avi.Inputs.NatpolicyRuleActionNatInfoNatIpRangeBeginArgs
{
Addr = "string",
Type = "string",
},
},
Ends = new[]
{
new Avi.Inputs.NatpolicyRuleActionNatInfoNatIpRangeEndArgs
{
Addr = "string",
Type = "string",
},
},
},
},
NatIps = new[]
{
new Avi.Inputs.NatpolicyRuleActionNatInfoNatIpArgs
{
Addr = "string",
Type = "string",
},
},
},
},
},
},
Enable = "string",
Index = "string",
Matches = new[]
{
new Avi.Inputs.NatpolicyRuleMatchArgs
{
DestinationIps = new[]
{
new Avi.Inputs.NatpolicyRuleMatchDestinationIpArgs
{
MatchCriteria = "string",
Addrs = new[]
{
new Avi.Inputs.NatpolicyRuleMatchDestinationIpAddrArgs
{
Addr = "string",
Type = "string",
},
},
GroupRefs = new[]
{
"string",
},
Prefixes = new[]
{
new Avi.Inputs.NatpolicyRuleMatchDestinationIpPrefixArgs
{
IpAddrs = new[]
{
new Avi.Inputs.NatpolicyRuleMatchDestinationIpPrefixIpAddrArgs
{
Addr = "string",
Type = "string",
},
},
Mask = "string",
},
},
Ranges = new[]
{
new Avi.Inputs.NatpolicyRuleMatchDestinationIpRangeArgs
{
Begins = new[]
{
new Avi.Inputs.NatpolicyRuleMatchDestinationIpRangeBeginArgs
{
Addr = "string",
Type = "string",
},
},
Ends = new[]
{
new Avi.Inputs.NatpolicyRuleMatchDestinationIpRangeEndArgs
{
Addr = "string",
Type = "string",
},
},
},
},
},
},
Services = new[]
{
new Avi.Inputs.NatpolicyRuleMatchServiceArgs
{
DestinationPorts = new[]
{
new Avi.Inputs.NatpolicyRuleMatchServiceDestinationPortArgs
{
MatchCriteria = "string",
Ports = new[]
{
0,
},
},
},
Protocols = new[]
{
new Avi.Inputs.NatpolicyRuleMatchServiceProtocolArgs
{
MatchCriteria = "string",
Protocol = "string",
},
},
SourcePorts = new[]
{
new Avi.Inputs.NatpolicyRuleMatchServiceSourcePortArgs
{
MatchCriteria = "string",
Ports = new[]
{
0,
},
},
},
},
},
SourceIps = new[]
{
new Avi.Inputs.NatpolicyRuleMatchSourceIpArgs
{
MatchCriteria = "string",
Addrs = new[]
{
new Avi.Inputs.NatpolicyRuleMatchSourceIpAddrArgs
{
Addr = "string",
Type = "string",
},
},
GroupRefs = new[]
{
"string",
},
Prefixes = new[]
{
new Avi.Inputs.NatpolicyRuleMatchSourceIpPrefixArgs
{
IpAddrs = new[]
{
new Avi.Inputs.NatpolicyRuleMatchSourceIpPrefixIpAddrArgs
{
Addr = "string",
Type = "string",
},
},
Mask = "string",
},
},
Ranges = new[]
{
new Avi.Inputs.NatpolicyRuleMatchSourceIpRangeArgs
{
Begins = new[]
{
new Avi.Inputs.NatpolicyRuleMatchSourceIpRangeBeginArgs
{
Addr = "string",
Type = "string",
},
},
Ends = new[]
{
new Avi.Inputs.NatpolicyRuleMatchSourceIpRangeEndArgs
{
Addr = "string",
Type = "string",
},
},
},
},
},
},
},
},
Name = "string",
CreatedBy = "string",
},
},
TenantRef = "string",
Uuid = "string",
});
example, err := avi.NewNatpolicy(ctx, "natpolicyResource", &avi.NatpolicyArgs{
ConfigpbAttributes: avi.NatpolicyConfigpbAttributeArray{
&avi.NatpolicyConfigpbAttributeArgs{
Version: pulumi.String("string"),
},
},
CreatedBy: pulumi.String("string"),
Description: pulumi.String("string"),
Markers: avi.NatpolicyMarkerArray{
&avi.NatpolicyMarkerArgs{
Key: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Name: pulumi.String("string"),
NatpolicyId: pulumi.String("string"),
Rules: avi.NatpolicyRuleArray{
&avi.NatpolicyRuleArgs{
Actions: avi.NatpolicyRuleActionArray{
&avi.NatpolicyRuleActionArgs{
Type: pulumi.String("string"),
NatInfos: avi.NatpolicyRuleActionNatInfoArray{
&avi.NatpolicyRuleActionNatInfoArgs{
NatIpRanges: avi.NatpolicyRuleActionNatInfoNatIpRangeArray{
&avi.NatpolicyRuleActionNatInfoNatIpRangeArgs{
Begins: avi.NatpolicyRuleActionNatInfoNatIpRangeBeginArray{
&avi.NatpolicyRuleActionNatInfoNatIpRangeBeginArgs{
Addr: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
Ends: avi.NatpolicyRuleActionNatInfoNatIpRangeEndArray{
&avi.NatpolicyRuleActionNatInfoNatIpRangeEndArgs{
Addr: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
},
},
NatIps: avi.NatpolicyRuleActionNatInfoNatIpArray{
&avi.NatpolicyRuleActionNatInfoNatIpArgs{
Addr: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
},
},
},
},
Enable: pulumi.String("string"),
Index: pulumi.String("string"),
Matches: avi.NatpolicyRuleMatchArray{
&avi.NatpolicyRuleMatchArgs{
DestinationIps: avi.NatpolicyRuleMatchDestinationIpArray{
&avi.NatpolicyRuleMatchDestinationIpArgs{
MatchCriteria: pulumi.String("string"),
Addrs: avi.NatpolicyRuleMatchDestinationIpAddrArray{
&avi.NatpolicyRuleMatchDestinationIpAddrArgs{
Addr: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
GroupRefs: pulumi.StringArray{
pulumi.String("string"),
},
Prefixes: avi.NatpolicyRuleMatchDestinationIpPrefixArray{
&avi.NatpolicyRuleMatchDestinationIpPrefixArgs{
IpAddrs: avi.NatpolicyRuleMatchDestinationIpPrefixIpAddrArray{
&avi.NatpolicyRuleMatchDestinationIpPrefixIpAddrArgs{
Addr: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
Mask: pulumi.String("string"),
},
},
Ranges: avi.NatpolicyRuleMatchDestinationIpRangeArray{
&avi.NatpolicyRuleMatchDestinationIpRangeArgs{
Begins: avi.NatpolicyRuleMatchDestinationIpRangeBeginArray{
&avi.NatpolicyRuleMatchDestinationIpRangeBeginArgs{
Addr: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
Ends: avi.NatpolicyRuleMatchDestinationIpRangeEndArray{
&avi.NatpolicyRuleMatchDestinationIpRangeEndArgs{
Addr: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
},
},
},
},
Services: avi.NatpolicyRuleMatchServiceArray{
&avi.NatpolicyRuleMatchServiceArgs{
DestinationPorts: avi.NatpolicyRuleMatchServiceDestinationPortArray{
&avi.NatpolicyRuleMatchServiceDestinationPortArgs{
MatchCriteria: pulumi.String("string"),
Ports: pulumi.Float64Array{
pulumi.Float64(0),
},
},
},
Protocols: avi.NatpolicyRuleMatchServiceProtocolArray{
&avi.NatpolicyRuleMatchServiceProtocolArgs{
MatchCriteria: pulumi.String("string"),
Protocol: pulumi.String("string"),
},
},
SourcePorts: avi.NatpolicyRuleMatchServiceSourcePortArray{
&avi.NatpolicyRuleMatchServiceSourcePortArgs{
MatchCriteria: pulumi.String("string"),
Ports: pulumi.Float64Array{
pulumi.Float64(0),
},
},
},
},
},
SourceIps: avi.NatpolicyRuleMatchSourceIpArray{
&avi.NatpolicyRuleMatchSourceIpArgs{
MatchCriteria: pulumi.String("string"),
Addrs: avi.NatpolicyRuleMatchSourceIpAddrArray{
&avi.NatpolicyRuleMatchSourceIpAddrArgs{
Addr: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
GroupRefs: pulumi.StringArray{
pulumi.String("string"),
},
Prefixes: avi.NatpolicyRuleMatchSourceIpPrefixArray{
&avi.NatpolicyRuleMatchSourceIpPrefixArgs{
IpAddrs: avi.NatpolicyRuleMatchSourceIpPrefixIpAddrArray{
&avi.NatpolicyRuleMatchSourceIpPrefixIpAddrArgs{
Addr: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
Mask: pulumi.String("string"),
},
},
Ranges: avi.NatpolicyRuleMatchSourceIpRangeArray{
&avi.NatpolicyRuleMatchSourceIpRangeArgs{
Begins: avi.NatpolicyRuleMatchSourceIpRangeBeginArray{
&avi.NatpolicyRuleMatchSourceIpRangeBeginArgs{
Addr: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
Ends: avi.NatpolicyRuleMatchSourceIpRangeEndArray{
&avi.NatpolicyRuleMatchSourceIpRangeEndArgs{
Addr: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
},
},
},
},
},
},
Name: pulumi.String("string"),
CreatedBy: pulumi.String("string"),
},
},
TenantRef: pulumi.String("string"),
Uuid: pulumi.String("string"),
})
var natpolicyResource = new Natpolicy("natpolicyResource", NatpolicyArgs.builder()
.configpbAttributes(NatpolicyConfigpbAttributeArgs.builder()
.version("string")
.build())
.createdBy("string")
.description("string")
.markers(NatpolicyMarkerArgs.builder()
.key("string")
.values("string")
.build())
.name("string")
.natpolicyId("string")
.rules(NatpolicyRuleArgs.builder()
.actions(NatpolicyRuleActionArgs.builder()
.type("string")
.natInfos(NatpolicyRuleActionNatInfoArgs.builder()
.natIpRanges(NatpolicyRuleActionNatInfoNatIpRangeArgs.builder()
.begins(NatpolicyRuleActionNatInfoNatIpRangeBeginArgs.builder()
.addr("string")
.type("string")
.build())
.ends(NatpolicyRuleActionNatInfoNatIpRangeEndArgs.builder()
.addr("string")
.type("string")
.build())
.build())
.natIps(NatpolicyRuleActionNatInfoNatIpArgs.builder()
.addr("string")
.type("string")
.build())
.build())
.build())
.enable("string")
.index("string")
.matches(NatpolicyRuleMatchArgs.builder()
.destinationIps(NatpolicyRuleMatchDestinationIpArgs.builder()
.matchCriteria("string")
.addrs(NatpolicyRuleMatchDestinationIpAddrArgs.builder()
.addr("string")
.type("string")
.build())
.groupRefs("string")
.prefixes(NatpolicyRuleMatchDestinationIpPrefixArgs.builder()
.ipAddrs(NatpolicyRuleMatchDestinationIpPrefixIpAddrArgs.builder()
.addr("string")
.type("string")
.build())
.mask("string")
.build())
.ranges(NatpolicyRuleMatchDestinationIpRangeArgs.builder()
.begins(NatpolicyRuleMatchDestinationIpRangeBeginArgs.builder()
.addr("string")
.type("string")
.build())
.ends(NatpolicyRuleMatchDestinationIpRangeEndArgs.builder()
.addr("string")
.type("string")
.build())
.build())
.build())
.services(NatpolicyRuleMatchServiceArgs.builder()
.destinationPorts(NatpolicyRuleMatchServiceDestinationPortArgs.builder()
.matchCriteria("string")
.ports(0)
.build())
.protocols(NatpolicyRuleMatchServiceProtocolArgs.builder()
.matchCriteria("string")
.protocol("string")
.build())
.sourcePorts(NatpolicyRuleMatchServiceSourcePortArgs.builder()
.matchCriteria("string")
.ports(0)
.build())
.build())
.sourceIps(NatpolicyRuleMatchSourceIpArgs.builder()
.matchCriteria("string")
.addrs(NatpolicyRuleMatchSourceIpAddrArgs.builder()
.addr("string")
.type("string")
.build())
.groupRefs("string")
.prefixes(NatpolicyRuleMatchSourceIpPrefixArgs.builder()
.ipAddrs(NatpolicyRuleMatchSourceIpPrefixIpAddrArgs.builder()
.addr("string")
.type("string")
.build())
.mask("string")
.build())
.ranges(NatpolicyRuleMatchSourceIpRangeArgs.builder()
.begins(NatpolicyRuleMatchSourceIpRangeBeginArgs.builder()
.addr("string")
.type("string")
.build())
.ends(NatpolicyRuleMatchSourceIpRangeEndArgs.builder()
.addr("string")
.type("string")
.build())
.build())
.build())
.build())
.name("string")
.createdBy("string")
.build())
.tenantRef("string")
.uuid("string")
.build());
natpolicy_resource = avi.Natpolicy("natpolicyResource",
configpb_attributes=[{
"version": "string",
}],
created_by="string",
description="string",
markers=[{
"key": "string",
"values": ["string"],
}],
name="string",
natpolicy_id="string",
rules=[{
"actions": [{
"type": "string",
"nat_infos": [{
"nat_ip_ranges": [{
"begins": [{
"addr": "string",
"type": "string",
}],
"ends": [{
"addr": "string",
"type": "string",
}],
}],
"nat_ips": [{
"addr": "string",
"type": "string",
}],
}],
}],
"enable": "string",
"index": "string",
"matches": [{
"destination_ips": [{
"match_criteria": "string",
"addrs": [{
"addr": "string",
"type": "string",
}],
"group_refs": ["string"],
"prefixes": [{
"ip_addrs": [{
"addr": "string",
"type": "string",
}],
"mask": "string",
}],
"ranges": [{
"begins": [{
"addr": "string",
"type": "string",
}],
"ends": [{
"addr": "string",
"type": "string",
}],
}],
}],
"services": [{
"destination_ports": [{
"match_criteria": "string",
"ports": [0],
}],
"protocols": [{
"match_criteria": "string",
"protocol": "string",
}],
"source_ports": [{
"match_criteria": "string",
"ports": [0],
}],
}],
"source_ips": [{
"match_criteria": "string",
"addrs": [{
"addr": "string",
"type": "string",
}],
"group_refs": ["string"],
"prefixes": [{
"ip_addrs": [{
"addr": "string",
"type": "string",
}],
"mask": "string",
}],
"ranges": [{
"begins": [{
"addr": "string",
"type": "string",
}],
"ends": [{
"addr": "string",
"type": "string",
}],
}],
}],
}],
"name": "string",
"created_by": "string",
}],
tenant_ref="string",
uuid="string")
const natpolicyResource = new avi.Natpolicy("natpolicyResource", {
configpbAttributes: [{
version: "string",
}],
createdBy: "string",
description: "string",
markers: [{
key: "string",
values: ["string"],
}],
name: "string",
natpolicyId: "string",
rules: [{
actions: [{
type: "string",
natInfos: [{
natIpRanges: [{
begins: [{
addr: "string",
type: "string",
}],
ends: [{
addr: "string",
type: "string",
}],
}],
natIps: [{
addr: "string",
type: "string",
}],
}],
}],
enable: "string",
index: "string",
matches: [{
destinationIps: [{
matchCriteria: "string",
addrs: [{
addr: "string",
type: "string",
}],
groupRefs: ["string"],
prefixes: [{
ipAddrs: [{
addr: "string",
type: "string",
}],
mask: "string",
}],
ranges: [{
begins: [{
addr: "string",
type: "string",
}],
ends: [{
addr: "string",
type: "string",
}],
}],
}],
services: [{
destinationPorts: [{
matchCriteria: "string",
ports: [0],
}],
protocols: [{
matchCriteria: "string",
protocol: "string",
}],
sourcePorts: [{
matchCriteria: "string",
ports: [0],
}],
}],
sourceIps: [{
matchCriteria: "string",
addrs: [{
addr: "string",
type: "string",
}],
groupRefs: ["string"],
prefixes: [{
ipAddrs: [{
addr: "string",
type: "string",
}],
mask: "string",
}],
ranges: [{
begins: [{
addr: "string",
type: "string",
}],
ends: [{
addr: "string",
type: "string",
}],
}],
}],
}],
name: "string",
createdBy: "string",
}],
tenantRef: "string",
uuid: "string",
});
type: avi:Natpolicy
properties:
configpbAttributes:
- version: string
createdBy: string
description: string
markers:
- key: string
values:
- string
name: string
natpolicyId: string
rules:
- actions:
- natInfos:
- natIpRanges:
- begins:
- addr: string
type: string
ends:
- addr: string
type: string
natIps:
- addr: string
type: string
type: string
createdBy: string
enable: string
index: string
matches:
- destinationIps:
- addrs:
- addr: string
type: string
groupRefs:
- string
matchCriteria: string
prefixes:
- ipAddrs:
- addr: string
type: string
mask: string
ranges:
- begins:
- addr: string
type: string
ends:
- addr: string
type: string
services:
- destinationPorts:
- matchCriteria: string
ports:
- 0
protocols:
- matchCriteria: string
protocol: string
sourcePorts:
- matchCriteria: string
ports:
- 0
sourceIps:
- addrs:
- addr: string
type: string
groupRefs:
- string
matchCriteria: string
prefixes:
- ipAddrs:
- addr: string
type: string
mask: string
ranges:
- begins:
- addr: string
type: string
ends:
- addr: string
type: string
name: string
tenantRef: string
uuid: string
Natpolicy 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 Natpolicy resource accepts the following input properties:
- Configpb
Attributes List<NatpolicyConfigpb Attribute> - Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Created
By string - Creator name. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Description string
- Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Markers
List<Natpolicy
Marker> - List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Name string
- Name of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Natpolicy
Id string - Rules
List<Natpolicy
Rule> - Nat policy rules. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Tenant
Ref string - It is a reference to an object of type tenant. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Uuid string
- Uuid of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Configpb
Attributes []NatpolicyConfigpb Attribute Args - Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Created
By string - Creator name. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Description string
- Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Markers
[]Natpolicy
Marker Args - List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Name string
- Name of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Natpolicy
Id string - Rules
[]Natpolicy
Rule Args - Nat policy rules. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Tenant
Ref string - It is a reference to an object of type tenant. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Uuid string
- Uuid of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- configpb
Attributes List<NatpolicyConfigpb Attribute> - Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- created
By String - Creator name. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- description String
- Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- markers
List<Natpolicy
Marker> - List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- name String
- Name of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- natpolicy
Id String - rules
List<Natpolicy
Rule> - Nat policy rules. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- tenant
Ref String - It is a reference to an object of type tenant. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- uuid String
- Uuid of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- configpb
Attributes NatpolicyConfigpb Attribute[] - Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- created
By string - Creator name. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- description string
- Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- markers
Natpolicy
Marker[] - List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- name string
- Name of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- natpolicy
Id string - rules
Natpolicy
Rule[] - Nat policy rules. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- tenant
Ref string - It is a reference to an object of type tenant. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- uuid string
- Uuid of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- configpb_
attributes Sequence[NatpolicyConfigpb Attribute Args] - Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- created_
by str - Creator name. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- description str
- Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- markers
Sequence[Natpolicy
Marker Args] - List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- name str
- Name of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- natpolicy_
id str - rules
Sequence[Natpolicy
Rule Args] - Nat policy rules. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- tenant_
ref str - It is a reference to an object of type tenant. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- uuid str
- Uuid of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- configpb
Attributes List<Property Map> - Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- created
By String - Creator name. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- description String
- Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- markers List<Property Map>
- List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- name String
- Name of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- natpolicy
Id String - rules List<Property Map>
- Nat policy rules. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- tenant
Ref String - It is a reference to an object of type tenant. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- uuid String
- Uuid of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Outputs
All input properties are implicitly available as output properties. Additionally, the Natpolicy resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing Natpolicy Resource
Get an existing Natpolicy 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?: NatpolicyState, opts?: CustomResourceOptions): Natpolicy@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
configpb_attributes: Optional[Sequence[NatpolicyConfigpbAttributeArgs]] = None,
created_by: Optional[str] = None,
description: Optional[str] = None,
markers: Optional[Sequence[NatpolicyMarkerArgs]] = None,
name: Optional[str] = None,
natpolicy_id: Optional[str] = None,
rules: Optional[Sequence[NatpolicyRuleArgs]] = None,
tenant_ref: Optional[str] = None,
uuid: Optional[str] = None) -> Natpolicyfunc GetNatpolicy(ctx *Context, name string, id IDInput, state *NatpolicyState, opts ...ResourceOption) (*Natpolicy, error)public static Natpolicy Get(string name, Input<string> id, NatpolicyState? state, CustomResourceOptions? opts = null)public static Natpolicy get(String name, Output<String> id, NatpolicyState state, CustomResourceOptions options)resources: _: type: avi:Natpolicy get: id: ${id}- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Configpb
Attributes List<NatpolicyConfigpb Attribute> - Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Created
By string - Creator name. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Description string
- Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Markers
List<Natpolicy
Marker> - List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Name string
- Name of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Natpolicy
Id string - Rules
List<Natpolicy
Rule> - Nat policy rules. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Tenant
Ref string - It is a reference to an object of type tenant. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Uuid string
- Uuid of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Configpb
Attributes []NatpolicyConfigpb Attribute Args - Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Created
By string - Creator name. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Description string
- Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Markers
[]Natpolicy
Marker Args - List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Name string
- Name of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Natpolicy
Id string - Rules
[]Natpolicy
Rule Args - Nat policy rules. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Tenant
Ref string - It is a reference to an object of type tenant. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Uuid string
- Uuid of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- configpb
Attributes List<NatpolicyConfigpb Attribute> - Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- created
By String - Creator name. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- description String
- Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- markers
List<Natpolicy
Marker> - List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- name String
- Name of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- natpolicy
Id String - rules
List<Natpolicy
Rule> - Nat policy rules. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- tenant
Ref String - It is a reference to an object of type tenant. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- uuid String
- Uuid of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- configpb
Attributes NatpolicyConfigpb Attribute[] - Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- created
By string - Creator name. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- description string
- Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- markers
Natpolicy
Marker[] - List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- name string
- Name of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- natpolicy
Id string - rules
Natpolicy
Rule[] - Nat policy rules. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- tenant
Ref string - It is a reference to an object of type tenant. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- uuid string
- Uuid of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- configpb_
attributes Sequence[NatpolicyConfigpb Attribute Args] - Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- created_
by str - Creator name. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- description str
- Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- markers
Sequence[Natpolicy
Marker Args] - List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- name str
- Name of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- natpolicy_
id str - rules
Sequence[Natpolicy
Rule Args] - Nat policy rules. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- tenant_
ref str - It is a reference to an object of type tenant. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- uuid str
- Uuid of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- configpb
Attributes List<Property Map> - Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- created
By String - Creator name. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- description String
- Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- markers List<Property Map>
- List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- name String
- Name of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- natpolicy
Id String - rules List<Property Map>
- Nat policy rules. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- tenant
Ref String - It is a reference to an object of type tenant. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- uuid String
- Uuid of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Supporting Types
NatpolicyConfigpbAttribute, NatpolicyConfigpbAttributeArgs
- Version string
- Version string
- version String
- version string
- version str
- version String
NatpolicyMarker, NatpolicyMarkerArgs
NatpolicyRule, NatpolicyRuleArgs
- Actions
List<Natpolicy
Rule Action> - Enable string
- Index string
- Matches
List<Natpolicy
Rule Match> - Name string
- Name of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Created
By string - Creator name. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Actions
[]Natpolicy
Rule Action - Enable string
- Index string
- Matches
[]Natpolicy
Rule Match - Name string
- Name of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Created
By string - Creator name. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- actions
List<Natpolicy
Rule Action> - enable String
- index String
- matches
List<Natpolicy
Rule Match> - name String
- Name of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- created
By String - Creator name. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- actions
Natpolicy
Rule Action[] - enable string
- index string
- matches
Natpolicy
Rule Match[] - name string
- Name of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- created
By string - Creator name. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- actions
Sequence[Natpolicy
Rule Action] - enable str
- index str
- matches
Sequence[Natpolicy
Rule Match] - name str
- Name of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- created_
by str - Creator name. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- actions List<Property Map>
- enable String
- index String
- matches List<Property Map>
- name String
- Name of the nat policy. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- created
By String - Creator name. Field introduced in 18.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
NatpolicyRuleAction, NatpolicyRuleActionArgs
- type String
- nat
Infos List<Property Map>
NatpolicyRuleActionNatInfo, NatpolicyRuleActionNatInfoArgs
NatpolicyRuleActionNatInfoNatIp, NatpolicyRuleActionNatInfoNatIpArgs
NatpolicyRuleActionNatInfoNatIpRange, NatpolicyRuleActionNatInfoNatIpRangeArgs
NatpolicyRuleActionNatInfoNatIpRangeBegin, NatpolicyRuleActionNatInfoNatIpRangeBeginArgs
NatpolicyRuleActionNatInfoNatIpRangeEnd, NatpolicyRuleActionNatInfoNatIpRangeEndArgs
NatpolicyRuleMatch, NatpolicyRuleMatchArgs
NatpolicyRuleMatchDestinationIp, NatpolicyRuleMatchDestinationIpArgs
NatpolicyRuleMatchDestinationIpAddr, NatpolicyRuleMatchDestinationIpAddrArgs
NatpolicyRuleMatchDestinationIpPrefix, NatpolicyRuleMatchDestinationIpPrefixArgs
- ip
Addrs List<Property Map> - mask String
NatpolicyRuleMatchDestinationIpPrefixIpAddr, NatpolicyRuleMatchDestinationIpPrefixIpAddrArgs
NatpolicyRuleMatchDestinationIpRange, NatpolicyRuleMatchDestinationIpRangeArgs
NatpolicyRuleMatchDestinationIpRangeBegin, NatpolicyRuleMatchDestinationIpRangeBeginArgs
NatpolicyRuleMatchDestinationIpRangeEnd, NatpolicyRuleMatchDestinationIpRangeEndArgs
NatpolicyRuleMatchService, NatpolicyRuleMatchServiceArgs
NatpolicyRuleMatchServiceDestinationPort, NatpolicyRuleMatchServiceDestinationPortArgs
- Match
Criteria string - Ports List<double>
- Match
Criteria string - Ports []float64
- match
Criteria String - ports List<Double>
- match
Criteria string - ports number[]
- match_
criteria str - ports Sequence[float]
- match
Criteria String - ports List<Number>
NatpolicyRuleMatchServiceProtocol, NatpolicyRuleMatchServiceProtocolArgs
- Match
Criteria string - Protocol string
- Match
Criteria string - Protocol string
- match
Criteria String - protocol String
- match
Criteria string - protocol string
- match_
criteria str - protocol str
- match
Criteria String - protocol String
NatpolicyRuleMatchServiceSourcePort, NatpolicyRuleMatchServiceSourcePortArgs
- Match
Criteria string - Ports List<double>
- Match
Criteria string - Ports []float64
- match
Criteria String - ports List<Double>
- match
Criteria string - ports number[]
- match_
criteria str - ports Sequence[float]
- match
Criteria String - ports List<Number>
NatpolicyRuleMatchSourceIp, NatpolicyRuleMatchSourceIpArgs
NatpolicyRuleMatchSourceIpAddr, NatpolicyRuleMatchSourceIpAddrArgs
NatpolicyRuleMatchSourceIpPrefix, NatpolicyRuleMatchSourceIpPrefixArgs
- ip
Addrs List<Property Map> - mask String
NatpolicyRuleMatchSourceIpPrefixIpAddr, NatpolicyRuleMatchSourceIpPrefixIpAddrArgs
NatpolicyRuleMatchSourceIpRange, NatpolicyRuleMatchSourceIpRangeArgs
NatpolicyRuleMatchSourceIpRangeBegin, NatpolicyRuleMatchSourceIpRangeBeginArgs
NatpolicyRuleMatchSourceIpRangeEnd, NatpolicyRuleMatchSourceIpRangeEndArgs
Package Details
- Repository
- avi vmware/terraform-provider-avi
- License
- Notes
- This Pulumi package is based on the
aviTerraform Provider.