zia.TrafficForwardingVPNCredentials
Explore with Pulumi AI
The zia_traffic_forwarding_vpn_credentials creates and manages VPN credentials that can be associated to locations. VPN is one way to route traffic from customer locations to the cloud. Site-to-site IPSec VPN credentials can be identified by the cloud through one of the following methods:
- Common Name (CN) of IPSec Certificate
- VPN User FQDN - requires VPN_SITE_TO_SITE subscription
- VPN IP Address - requires VPN_SITE_TO_SITE subscription
- Extended Authentication (XAUTH) or hosted mobile UserID - requires VPN_MOBILE subscription
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as zia from "@bdzscaler/pulumi-zia";
//######## PASSWORDS IN THIS FILE ARE FAKE AND NOT USED IN PRODUCTION SYSTEMS #########
// ZIA Traffic Forwarding - VPN Credentials (UFQDN)
const example = new zia.TrafficForwardingVPNCredentials("example", {
comments: "Example",
fqdn: "sjc-1-37@acme.com",
preSharedKey: "*********************",
type: "UFQDN",
});
import pulumi
import zscaler_pulumi_zia as zia
######### PASSWORDS IN THIS FILE ARE FAKE AND NOT USED IN PRODUCTION SYSTEMS #########
# ZIA Traffic Forwarding - VPN Credentials (UFQDN)
example = zia.TrafficForwardingVPNCredentials("example",
comments="Example",
fqdn="sjc-1-37@acme.com",
pre_shared_key="*********************",
type="UFQDN")
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/zscaler/pulumi-zia/sdk/go/zia"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// ######## PASSWORDS IN THIS FILE ARE FAKE AND NOT USED IN PRODUCTION SYSTEMS #########
// ZIA Traffic Forwarding - VPN Credentials (UFQDN)
_, err := zia.NewTrafficForwardingVPNCredentials(ctx, "example", &zia.TrafficForwardingVPNCredentialsArgs{
Comments: pulumi.String("Example"),
Fqdn: pulumi.String("sjc-1-37@acme.com"),
PreSharedKey: pulumi.String("*********************"),
Type: pulumi.String("UFQDN"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zia = zscaler.PulumiPackage.Zia;
return await Deployment.RunAsync(() =>
{
//######## PASSWORDS IN THIS FILE ARE FAKE AND NOT USED IN PRODUCTION SYSTEMS #########
// ZIA Traffic Forwarding - VPN Credentials (UFQDN)
var example = new Zia.TrafficForwardingVPNCredentials("example", new()
{
Comments = "Example",
Fqdn = "sjc-1-37@acme.com",
PreSharedKey = "*********************",
Type = "UFQDN",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zia.TrafficForwardingVPNCredentials;
import com.pulumi.zia.TrafficForwardingVPNCredentialsArgs;
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) {
//######## PASSWORDS IN THIS FILE ARE FAKE AND NOT USED IN PRODUCTION SYSTEMS #########
// ZIA Traffic Forwarding - VPN Credentials (UFQDN)
var example = new TrafficForwardingVPNCredentials("example", TrafficForwardingVPNCredentialsArgs.builder()
.comments("Example")
.fqdn("sjc-1-37@acme.com")
.preSharedKey("*********************")
.type("UFQDN")
.build());
}
}
resources:
######## PASSWORDS IN THIS FILE ARE FAKE AND NOT USED IN PRODUCTION SYSTEMS #########
# // ZIA Traffic Forwarding - VPN Credentials (UFQDN)
example:
type: zia:TrafficForwardingVPNCredentials
properties:
comments: Example
fqdn: sjc-1-37@acme.com
preSharedKey: '*********************'
type: UFQDN
import * as pulumi from "@pulumi/pulumi";
import * as zia from "@bdzscaler/pulumi-zia";
const exampleTrafficForwardingStaticIP = new zia.TrafficForwardingStaticIP("exampleTrafficForwardingStaticIP", {
ipAddress: "1.1.1.1",
routableIp: true,
comment: "Example",
geoOverride: true,
latitude: -36.848461,
longitude: 174.763336,
});
// ZIA Traffic Forwarding - VPN Credentials (IP)
//######## PASSWORDS IN THIS FILE ARE FAKE AND NOT USED IN PRODUCTION SYSTEMS #########
const exampleTrafficForwardingVPNCredentials = new zia.TrafficForwardingVPNCredentials("exampleTrafficForwardingVPNCredentials", {
type: "IP",
ipAddress: exampleTrafficForwardingStaticIP.ipAddress,
comments: "Example",
preSharedKey: "*********************",
}, {
dependsOn: [exampleTrafficForwardingStaticIP],
});
import pulumi
import zscaler_pulumi_zia as zia
example_traffic_forwarding_static_ip = zia.TrafficForwardingStaticIP("exampleTrafficForwardingStaticIP",
ip_address="1.1.1.1",
routable_ip=True,
comment="Example",
geo_override=True,
latitude=-36.848461,
longitude=174.763336)
# ZIA Traffic Forwarding - VPN Credentials (IP)
######### PASSWORDS IN THIS FILE ARE FAKE AND NOT USED IN PRODUCTION SYSTEMS #########
example_traffic_forwarding_vpn_credentials = zia.TrafficForwardingVPNCredentials("exampleTrafficForwardingVPNCredentials",
type="IP",
ip_address=example_traffic_forwarding_static_ip.ip_address,
comments="Example",
pre_shared_key="*********************",
opts = pulumi.ResourceOptions(depends_on=[example_traffic_forwarding_static_ip]))
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/zscaler/pulumi-zia/sdk/go/zia"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleTrafficForwardingStaticIP, err := zia.NewTrafficForwardingStaticIP(ctx, "exampleTrafficForwardingStaticIP", &zia.TrafficForwardingStaticIPArgs{
IpAddress: pulumi.String("1.1.1.1"),
RoutableIp: pulumi.Bool(true),
Comment: pulumi.String("Example"),
GeoOverride: pulumi.Bool(true),
Latitude: -36.848461,
Longitude: pulumi.Float64(174.763336),
})
if err != nil {
return err
}
// ZIA Traffic Forwarding - VPN Credentials (IP)
// ######## PASSWORDS IN THIS FILE ARE FAKE AND NOT USED IN PRODUCTION SYSTEMS #########
_, err = zia.NewTrafficForwardingVPNCredentials(ctx, "exampleTrafficForwardingVPNCredentials", &zia.TrafficForwardingVPNCredentialsArgs{
Type: pulumi.String("IP"),
IpAddress: exampleTrafficForwardingStaticIP.IpAddress,
Comments: pulumi.String("Example"),
PreSharedKey: pulumi.String("*********************"),
}, pulumi.DependsOn([]pulumi.Resource{
exampleTrafficForwardingStaticIP,
}))
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zia = zscaler.PulumiPackage.Zia;
return await Deployment.RunAsync(() =>
{
var exampleTrafficForwardingStaticIP = new Zia.TrafficForwardingStaticIP("exampleTrafficForwardingStaticIP", new()
{
IpAddress = "1.1.1.1",
RoutableIp = true,
Comment = "Example",
GeoOverride = true,
Latitude = -36.848461,
Longitude = 174.763336,
});
// ZIA Traffic Forwarding - VPN Credentials (IP)
//######## PASSWORDS IN THIS FILE ARE FAKE AND NOT USED IN PRODUCTION SYSTEMS #########
var exampleTrafficForwardingVPNCredentials = new Zia.TrafficForwardingVPNCredentials("exampleTrafficForwardingVPNCredentials", new()
{
Type = "IP",
IpAddress = exampleTrafficForwardingStaticIP.IpAddress,
Comments = "Example",
PreSharedKey = "*********************",
}, new CustomResourceOptions
{
DependsOn =
{
exampleTrafficForwardingStaticIP,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zia.TrafficForwardingStaticIP;
import com.pulumi.zia.TrafficForwardingStaticIPArgs;
import com.pulumi.zia.TrafficForwardingVPNCredentials;
import com.pulumi.zia.TrafficForwardingVPNCredentialsArgs;
import com.pulumi.resources.CustomResourceOptions;
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 exampleTrafficForwardingStaticIP = new TrafficForwardingStaticIP("exampleTrafficForwardingStaticIP", TrafficForwardingStaticIPArgs.builder()
.ipAddress("1.1.1.1")
.routableIp(true)
.comment("Example")
.geoOverride(true)
.latitude("TODO: GenUnaryOpExpression")
.longitude(174.763336)
.build());
// ZIA Traffic Forwarding - VPN Credentials (IP)
//######## PASSWORDS IN THIS FILE ARE FAKE AND NOT USED IN PRODUCTION SYSTEMS #########
var exampleTrafficForwardingVPNCredentials = new TrafficForwardingVPNCredentials("exampleTrafficForwardingVPNCredentials", TrafficForwardingVPNCredentialsArgs.builder()
.type("IP")
.ipAddress(exampleTrafficForwardingStaticIP.ipAddress())
.comments("Example")
.preSharedKey("*********************")
.build(), CustomResourceOptions.builder()
.dependsOn(exampleTrafficForwardingStaticIP)
.build());
}
}
resources:
# ZIA Traffic Forwarding - VPN Credentials (IP)
######### PASSWORDS IN THIS FILE ARE FAKE AND NOT USED IN PRODUCTION SYSTEMS #########
exampleTrafficForwardingVPNCredentials:
type: zia:TrafficForwardingVPNCredentials
properties:
type: IP
ipAddress: ${exampleTrafficForwardingStaticIP.ipAddress}
comments: Example
preSharedKey: '*********************'
options:
dependson:
- ${exampleTrafficForwardingStaticIP}
exampleTrafficForwardingStaticIP:
type: zia:TrafficForwardingStaticIP
properties:
ipAddress: 1.1.1.1
routableIp: true
comment: Example
geoOverride: true
latitude: -36.848461
longitude: 174.763336
NOTE For VPN Credentials of Type
IP
a static IP resource must be created first.
Create TrafficForwardingVPNCredentials Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new TrafficForwardingVPNCredentials(name: string, args?: TrafficForwardingVPNCredentialsArgs, opts?: CustomResourceOptions);
@overload
def TrafficForwardingVPNCredentials(resource_name: str,
args: Optional[TrafficForwardingVPNCredentialsArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def TrafficForwardingVPNCredentials(resource_name: str,
opts: Optional[ResourceOptions] = None,
comments: Optional[str] = None,
fqdn: Optional[str] = None,
ip_address: Optional[str] = None,
pre_shared_key: Optional[str] = None,
type: Optional[str] = None)
func NewTrafficForwardingVPNCredentials(ctx *Context, name string, args *TrafficForwardingVPNCredentialsArgs, opts ...ResourceOption) (*TrafficForwardingVPNCredentials, error)
public TrafficForwardingVPNCredentials(string name, TrafficForwardingVPNCredentialsArgs? args = null, CustomResourceOptions? opts = null)
public TrafficForwardingVPNCredentials(String name, TrafficForwardingVPNCredentialsArgs args)
public TrafficForwardingVPNCredentials(String name, TrafficForwardingVPNCredentialsArgs args, CustomResourceOptions options)
type: zia:TrafficForwardingVPNCredentials
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 TrafficForwardingVPNCredentialsArgs
- 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 TrafficForwardingVPNCredentialsArgs
- 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 TrafficForwardingVPNCredentialsArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TrafficForwardingVPNCredentialsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TrafficForwardingVPNCredentialsArgs
- 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 trafficForwardingVPNCredentialsResource = new Zia.TrafficForwardingVPNCredentials("trafficForwardingVPNCredentialsResource", new()
{
Comments = "string",
Fqdn = "string",
IpAddress = "string",
PreSharedKey = "string",
Type = "string",
});
example, err := zia.NewTrafficForwardingVPNCredentials(ctx, "trafficForwardingVPNCredentialsResource", &zia.TrafficForwardingVPNCredentialsArgs{
Comments: pulumi.String("string"),
Fqdn: pulumi.String("string"),
IpAddress: pulumi.String("string"),
PreSharedKey: pulumi.String("string"),
Type: pulumi.String("string"),
})
var trafficForwardingVPNCredentialsResource = new TrafficForwardingVPNCredentials("trafficForwardingVPNCredentialsResource", TrafficForwardingVPNCredentialsArgs.builder()
.comments("string")
.fqdn("string")
.ipAddress("string")
.preSharedKey("string")
.type("string")
.build());
traffic_forwarding_vpn_credentials_resource = zia.TrafficForwardingVPNCredentials("trafficForwardingVPNCredentialsResource",
comments="string",
fqdn="string",
ip_address="string",
pre_shared_key="string",
type="string")
const trafficForwardingVPNCredentialsResource = new zia.TrafficForwardingVPNCredentials("trafficForwardingVPNCredentialsResource", {
comments: "string",
fqdn: "string",
ipAddress: "string",
preSharedKey: "string",
type: "string",
});
type: zia:TrafficForwardingVPNCredentials
properties:
comments: string
fqdn: string
ipAddress: string
preSharedKey: string
type: string
TrafficForwardingVPNCredentials 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 TrafficForwardingVPNCredentials resource accepts the following input properties:
- Comments string
- Fqdn string
- Fully Qualified Domain Name. Applicable only to
UFQDN
orXAUTH
(orHOSTED_MOBILE_USERS
) auth type. - Ip
Address string - string
- Pre-shared key. This is a required field for UFQDN and IP auth type.
- Type string
- VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created. The supported values are:
UFQDN
andIP
- Comments string
- Fqdn string
- Fully Qualified Domain Name. Applicable only to
UFQDN
orXAUTH
(orHOSTED_MOBILE_USERS
) auth type. - Ip
Address string - string
- Pre-shared key. This is a required field for UFQDN and IP auth type.
- Type string
- VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created. The supported values are:
UFQDN
andIP
- comments String
- fqdn String
- Fully Qualified Domain Name. Applicable only to
UFQDN
orXAUTH
(orHOSTED_MOBILE_USERS
) auth type. - ip
Address String - String
- Pre-shared key. This is a required field for UFQDN and IP auth type.
- type String
- VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created. The supported values are:
UFQDN
andIP
- comments string
- fqdn string
- Fully Qualified Domain Name. Applicable only to
UFQDN
orXAUTH
(orHOSTED_MOBILE_USERS
) auth type. - ip
Address string - string
- Pre-shared key. This is a required field for UFQDN and IP auth type.
- type string
- VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created. The supported values are:
UFQDN
andIP
- comments str
- fqdn str
- Fully Qualified Domain Name. Applicable only to
UFQDN
orXAUTH
(orHOSTED_MOBILE_USERS
) auth type. - ip_
address str - str
- Pre-shared key. This is a required field for UFQDN and IP auth type.
- type str
- VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created. The supported values are:
UFQDN
andIP
- comments String
- fqdn String
- Fully Qualified Domain Name. Applicable only to
UFQDN
orXAUTH
(orHOSTED_MOBILE_USERS
) auth type. - ip
Address String - String
- Pre-shared key. This is a required field for UFQDN and IP auth type.
- type String
- VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created. The supported values are:
UFQDN
andIP
Outputs
All input properties are implicitly available as output properties. Additionally, the TrafficForwardingVPNCredentials resource produces the following output properties:
Look up Existing TrafficForwardingVPNCredentials Resource
Get an existing TrafficForwardingVPNCredentials 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?: TrafficForwardingVPNCredentialsState, opts?: CustomResourceOptions): TrafficForwardingVPNCredentials
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
comments: Optional[str] = None,
fqdn: Optional[str] = None,
ip_address: Optional[str] = None,
pre_shared_key: Optional[str] = None,
type: Optional[str] = None,
vpn_id: Optional[int] = None) -> TrafficForwardingVPNCredentials
func GetTrafficForwardingVPNCredentials(ctx *Context, name string, id IDInput, state *TrafficForwardingVPNCredentialsState, opts ...ResourceOption) (*TrafficForwardingVPNCredentials, error)
public static TrafficForwardingVPNCredentials Get(string name, Input<string> id, TrafficForwardingVPNCredentialsState? state, CustomResourceOptions? opts = null)
public static TrafficForwardingVPNCredentials get(String name, Output<String> id, TrafficForwardingVPNCredentialsState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- Comments string
- Fqdn string
- Fully Qualified Domain Name. Applicable only to
UFQDN
orXAUTH
(orHOSTED_MOBILE_USERS
) auth type. - Ip
Address string - string
- Pre-shared key. This is a required field for UFQDN and IP auth type.
- Type string
- VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created. The supported values are:
UFQDN
andIP
- Vpn
Id int
- Comments string
- Fqdn string
- Fully Qualified Domain Name. Applicable only to
UFQDN
orXAUTH
(orHOSTED_MOBILE_USERS
) auth type. - Ip
Address string - string
- Pre-shared key. This is a required field for UFQDN and IP auth type.
- Type string
- VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created. The supported values are:
UFQDN
andIP
- Vpn
Id int
- comments String
- fqdn String
- Fully Qualified Domain Name. Applicable only to
UFQDN
orXAUTH
(orHOSTED_MOBILE_USERS
) auth type. - ip
Address String - String
- Pre-shared key. This is a required field for UFQDN and IP auth type.
- type String
- VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created. The supported values are:
UFQDN
andIP
- vpn
Id Integer
- comments string
- fqdn string
- Fully Qualified Domain Name. Applicable only to
UFQDN
orXAUTH
(orHOSTED_MOBILE_USERS
) auth type. - ip
Address string - string
- Pre-shared key. This is a required field for UFQDN and IP auth type.
- type string
- VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created. The supported values are:
UFQDN
andIP
- vpn
Id number
- comments str
- fqdn str
- Fully Qualified Domain Name. Applicable only to
UFQDN
orXAUTH
(orHOSTED_MOBILE_USERS
) auth type. - ip_
address str - str
- Pre-shared key. This is a required field for UFQDN and IP auth type.
- type str
- VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created. The supported values are:
UFQDN
andIP
- vpn_
id int
- comments String
- fqdn String
- Fully Qualified Domain Name. Applicable only to
UFQDN
orXAUTH
(orHOSTED_MOBILE_USERS
) auth type. - ip
Address String - String
- Pre-shared key. This is a required field for UFQDN and IP auth type.
- type String
- VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created. The supported values are:
UFQDN
andIP
- vpn
Id Number
Import
Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZIA configurations into Terraform-compliant HashiCorp Configuration Language.
Visit
zia_traffic_forwarding_vpn_credentials can be imported by using one of the following prefixes as the import ID:
'IP'
- Imports all VPN Credentials of type IP
$ pulumi import zia:index/trafficForwardingVPNCredentials:TrafficForwardingVPNCredentials example 'IP'
'UFQDN'
- Imports all VPN Credentials of type UFQDN
$ pulumi import zia:index/trafficForwardingVPNCredentials:TrafficForwardingVPNCredentials this 'UFQDN'
UFQDN'
- Imports a VPN Credentials of type UFQDN containing a specific UFQDN address
$ pulumi import zia:index/trafficForwardingVPNCredentials:TrafficForwardingVPNCredentials example 'testvpn@example.com'
IP Address'
- Imports a VPN Credentials of type IP containing a specific IP address
$ pulumi import zia:index/trafficForwardingVPNCredentials:TrafficForwardingVPNCredentials example '1.1.1.1'
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- zia zscaler/pulumi-zia
- License
- MIT
- Notes
- This Pulumi package is based on the
zia
Terraform Provider.