1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. TrafficForwardingVpnCredentials
Viewing docs for pulumi-resource-zia v1.3.8
published on Friday, Mar 13, 2026 by Zscaler
Schema (JSON)
zscaler/pulumi-zia

zia.TrafficForwardingVpnCredentials

zia logo
Viewing docs for pulumi-resource-zia v1.3.8
published on Friday, Mar 13, 2026 by Zscaler
Schema (JSON)
zscaler/pulumi-zia

    The zia_traffic_forwarding_vpn_credentials resource manages VPN credentials for traffic forwarding in the Zscaler Internet Access (ZIA) cloud service. VPN credentials are used to authenticate IPSec VPN tunnels between on-premises equipment and the Zscaler cloud.

    For more information, see the ZIA Traffic Forwarding documentation.

    Example Usage

    Basic VPN Credentials (UFQDN)

    Example coming soon!

    Example coming soon!

    Example coming soon!

    import * as zia from "@bdzscaler/pulumi-zia";

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

const cfg = new pulumi.Config();
const vpnPreSharedKey = cfg.requireSecret("vpnPreSharedKey");

const example = new zia.TrafficForwardingVpnCredentials("example", {
    type: "UFQDN",
    fqdn: "user@example.com",
    preSharedKey: vpnPreSharedKey,
    comments: "Branch office VPN credentials",
});

    import pulumi
import zscaler_pulumi_zia as zia

cfg = pulumi.Config()
vpn_pre_shared_key = cfg.require_secret("vpnPreSharedKey")

example = zia.TrafficForwardingVpnCredentials("example",
    type="UFQDN",
    fqdn="user@example.com",
    pre_shared_key=vpn_pre_shared_key,
    comments="Branch office VPN credentials",
)

    resources:
  example:
    type: zia:TrafficForwardingVpnCredentials
    properties:
      type: UFQDN
      fqdn: user@example.com
      preSharedKey:
        fn::secret: ${vpnPreSharedKey}
      comments: Branch office VPN credentials

    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
    Additional information about the VPN credential. Maximum 10240 characters.
    Fqdn string
    Fully Qualified Domain Name (FQDN). Required when type is UFQDN.
    IpAddress string
    The static IP address associated with the VPN credential. Required when type is IP.
    PreSharedKey string
    Pre-shared key (PSK) for the VPN credential. This is a secret value.
    Type string
    VPN credential type. Valid values: IP, UFQDN.
    Comments string
    Additional information about the VPN credential. Maximum 10240 characters.
    Fqdn string
    Fully Qualified Domain Name (FQDN). Required when type is UFQDN.
    IpAddress string
    The static IP address associated with the VPN credential. Required when type is IP.
    PreSharedKey string
    Pre-shared key (PSK) for the VPN credential. This is a secret value.
    Type string
    VPN credential type. Valid values: IP, UFQDN.
    comments String
    Additional information about the VPN credential. Maximum 10240 characters.
    fqdn String
    Fully Qualified Domain Name (FQDN). Required when type is UFQDN.
    ipAddress String
    The static IP address associated with the VPN credential. Required when type is IP.
    preSharedKey String
    Pre-shared key (PSK) for the VPN credential. This is a secret value.
    type String
    VPN credential type. Valid values: IP, UFQDN.
    comments string
    Additional information about the VPN credential. Maximum 10240 characters.
    fqdn string
    Fully Qualified Domain Name (FQDN). Required when type is UFQDN.
    ipAddress string
    The static IP address associated with the VPN credential. Required when type is IP.
    preSharedKey string
    Pre-shared key (PSK) for the VPN credential. This is a secret value.
    type string
    VPN credential type. Valid values: IP, UFQDN.
    comments str
    Additional information about the VPN credential. Maximum 10240 characters.
    fqdn str
    Fully Qualified Domain Name (FQDN). Required when type is UFQDN.
    ip_address str
    The static IP address associated with the VPN credential. Required when type is IP.
    pre_shared_key str
    Pre-shared key (PSK) for the VPN credential. This is a secret value.
    type str
    VPN credential type. Valid values: IP, UFQDN.
    comments String
    Additional information about the VPN credential. Maximum 10240 characters.
    fqdn String
    Fully Qualified Domain Name (FQDN). Required when type is UFQDN.
    ipAddress String
    The static IP address associated with the VPN credential. Required when type is IP.
    preSharedKey String
    Pre-shared key (PSK) for the VPN credential. This is a secret value.
    type String
    VPN credential type. Valid values: IP, UFQDN.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    VpnId int
    The system-generated ID of the VPN credential.
    Id string
    The provider-assigned unique ID for this managed resource.
    VpnId int
    The system-generated ID of the VPN credential.
    id String
    The provider-assigned unique ID for this managed resource.
    vpnId Integer
    The system-generated ID of the VPN credential.
    id string
    The provider-assigned unique ID for this managed resource.
    vpnId number
    The system-generated ID of the VPN credential.
    id str
    The provider-assigned unique ID for this managed resource.
    vpn_id int
    The system-generated ID of the VPN credential.
    id String
    The provider-assigned unique ID for this managed resource.
    vpnId Number
    The system-generated ID of the VPN credential.

    Import

    An existing VPN credential can be imported using its resource ID, e.g.

    $ pulumi import zia:index:TrafficForwardingVpnCredentials example 12345

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    zia zscaler/pulumi-zia
    License
    zia logo
    Viewing docs for pulumi-resource-zia v1.3.8
    published on Friday, Mar 13, 2026 by Zscaler
    Schema (JSON)
    zscaler/pulumi-zia
      Try Pulumi Cloud free. Your team will thank you.