1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. TrafficForwardingStaticIP
Zscaler Internet Access v0.0.7 published on Tuesday, Jul 30, 2024 by Zscaler

zia.TrafficForwardingStaticIP

Explore with Pulumi AI

zia logo
Zscaler Internet Access v0.0.7 published on Tuesday, Jul 30, 2024 by Zscaler

    The zia_traffic_forwarding_static_ip resource allows the creation and management of static ip addresses in the Zscaler Internet Access cloud. The resource, can then be associated with other resources such as:

    • VPN Credentials of type IP
    • Location Management
    • GRE Tunnel

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as zia from "@bdzscaler/pulumi-zia";
    
    // ZIA Traffic Forwarding - Static IP
    const example = new zia.TrafficForwardingStaticIP("example", {
        comment: "Example",
        geoOverride: true,
        ipAddress: "1.1.1.1",
        latitude: -36.848461,
        longitude: 174.763336,
        routableIp: true,
    });
    
    import pulumi
    import zscaler_pulumi_zia as zia
    
    # ZIA Traffic Forwarding - Static IP
    example = zia.TrafficForwardingStaticIP("example",
        comment="Example",
        geo_override=True,
        ip_address="1.1.1.1",
        latitude=-36.848461,
        longitude=174.763336,
        routable_ip=True)
    
    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 {
    		// ZIA Traffic Forwarding - Static IP
    		_, err := zia.NewTrafficForwardingStaticIP(ctx, "example", &zia.TrafficForwardingStaticIPArgs{
    			Comment:     pulumi.String("Example"),
    			GeoOverride: pulumi.Bool(true),
    			IpAddress:   pulumi.String("1.1.1.1"),
    			Latitude:    -36.848461,
    			Longitude:   pulumi.Float64(174.763336),
    			RoutableIp:  pulumi.Bool(true),
    		})
    		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(() => 
    {
        // ZIA Traffic Forwarding - Static IP
        var example = new Zia.TrafficForwardingStaticIP("example", new()
        {
            Comment = "Example",
            GeoOverride = true,
            IpAddress = "1.1.1.1",
            Latitude = -36.848461,
            Longitude = 174.763336,
            RoutableIp = true,
        });
    
    });
    
    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 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) {
            // ZIA Traffic Forwarding - Static IP
            var example = new TrafficForwardingStaticIP("example", TrafficForwardingStaticIPArgs.builder()
                .comment("Example")
                .geoOverride(true)
                .ipAddress("1.1.1.1")
                .latitude("TODO: GenUnaryOpExpression")
                .longitude(174.763336)
                .routableIp(true)
                .build());
    
        }
    }
    
    resources:
      # ZIA Traffic Forwarding - Static IP
      example:
        type: zia:TrafficForwardingStaticIP
        properties:
          comment: Example
          geoOverride: true
          ipAddress: 1.1.1.1
          latitude: -36.848461
          longitude: 174.763336
          routableIp: true
    

    Create TrafficForwardingStaticIP Resource

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

    Constructor syntax

    new TrafficForwardingStaticIP(name: string, args: TrafficForwardingStaticIPArgs, opts?: CustomResourceOptions);
    @overload
    def TrafficForwardingStaticIP(resource_name: str,
                                  args: TrafficForwardingStaticIPArgs,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def TrafficForwardingStaticIP(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  ip_address: Optional[str] = None,
                                  comment: Optional[str] = None,
                                  geo_override: Optional[bool] = None,
                                  latitude: Optional[float] = None,
                                  longitude: Optional[float] = None,
                                  routable_ip: Optional[bool] = None)
    func NewTrafficForwardingStaticIP(ctx *Context, name string, args TrafficForwardingStaticIPArgs, opts ...ResourceOption) (*TrafficForwardingStaticIP, error)
    public TrafficForwardingStaticIP(string name, TrafficForwardingStaticIPArgs args, CustomResourceOptions? opts = null)
    public TrafficForwardingStaticIP(String name, TrafficForwardingStaticIPArgs args)
    public TrafficForwardingStaticIP(String name, TrafficForwardingStaticIPArgs args, CustomResourceOptions options)
    
    type: zia:TrafficForwardingStaticIP
    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 TrafficForwardingStaticIPArgs
    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 TrafficForwardingStaticIPArgs
    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 TrafficForwardingStaticIPArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TrafficForwardingStaticIPArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TrafficForwardingStaticIPArgs
    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 trafficForwardingStaticIPResource = new Zia.TrafficForwardingStaticIP("trafficForwardingStaticIPResource", new()
    {
        IpAddress = "string",
        Comment = "string",
        GeoOverride = false,
        Latitude = 0,
        Longitude = 0,
        RoutableIp = false,
    });
    
    example, err := zia.NewTrafficForwardingStaticIP(ctx, "trafficForwardingStaticIPResource", &zia.TrafficForwardingStaticIPArgs{
    	IpAddress:   pulumi.String("string"),
    	Comment:     pulumi.String("string"),
    	GeoOverride: pulumi.Bool(false),
    	Latitude:    pulumi.Float64(0),
    	Longitude:   pulumi.Float64(0),
    	RoutableIp:  pulumi.Bool(false),
    })
    
    var trafficForwardingStaticIPResource = new TrafficForwardingStaticIP("trafficForwardingStaticIPResource", TrafficForwardingStaticIPArgs.builder()
        .ipAddress("string")
        .comment("string")
        .geoOverride(false)
        .latitude(0)
        .longitude(0)
        .routableIp(false)
        .build());
    
    traffic_forwarding_static_ip_resource = zia.TrafficForwardingStaticIP("trafficForwardingStaticIPResource",
        ip_address="string",
        comment="string",
        geo_override=False,
        latitude=0,
        longitude=0,
        routable_ip=False)
    
    const trafficForwardingStaticIPResource = new zia.TrafficForwardingStaticIP("trafficForwardingStaticIPResource", {
        ipAddress: "string",
        comment: "string",
        geoOverride: false,
        latitude: 0,
        longitude: 0,
        routableIp: false,
    });
    
    type: zia:TrafficForwardingStaticIP
    properties:
        comment: string
        geoOverride: false
        ipAddress: string
        latitude: 0
        longitude: 0
        routableIp: false
    

    TrafficForwardingStaticIP 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 TrafficForwardingStaticIP resource accepts the following input properties:

    IpAddress string
    The static IP address
    Comment string
    Additional information about this static IP address
    GeoOverride bool
    If not set, geographic coordinates and city are automatically determined from the IP address. Otherwise, the latitude and longitude coordinates must be provided.
    Latitude double
    Required only if the geoOverride attribute is set. Latitude with 7 digit precision after decimal point, ranges between -90 and 90 degrees.
    Longitude double
    Required only if the geoOverride attribute is set. Longitude with 7 digit precision after decimal point, ranges between -180 and 180 degrees.
    RoutableIp bool
    Indicates whether a non-RFC 1918 IP address is publicly routable. This attribute is ignored if there is no ZIA Private Service Edge associated to the organization.
    IpAddress string
    The static IP address
    Comment string
    Additional information about this static IP address
    GeoOverride bool
    If not set, geographic coordinates and city are automatically determined from the IP address. Otherwise, the latitude and longitude coordinates must be provided.
    Latitude float64
    Required only if the geoOverride attribute is set. Latitude with 7 digit precision after decimal point, ranges between -90 and 90 degrees.
    Longitude float64
    Required only if the geoOverride attribute is set. Longitude with 7 digit precision after decimal point, ranges between -180 and 180 degrees.
    RoutableIp bool
    Indicates whether a non-RFC 1918 IP address is publicly routable. This attribute is ignored if there is no ZIA Private Service Edge associated to the organization.
    ipAddress String
    The static IP address
    comment String
    Additional information about this static IP address
    geoOverride Boolean
    If not set, geographic coordinates and city are automatically determined from the IP address. Otherwise, the latitude and longitude coordinates must be provided.
    latitude Double
    Required only if the geoOverride attribute is set. Latitude with 7 digit precision after decimal point, ranges between -90 and 90 degrees.
    longitude Double
    Required only if the geoOverride attribute is set. Longitude with 7 digit precision after decimal point, ranges between -180 and 180 degrees.
    routableIp Boolean
    Indicates whether a non-RFC 1918 IP address is publicly routable. This attribute is ignored if there is no ZIA Private Service Edge associated to the organization.
    ipAddress string
    The static IP address
    comment string
    Additional information about this static IP address
    geoOverride boolean
    If not set, geographic coordinates and city are automatically determined from the IP address. Otherwise, the latitude and longitude coordinates must be provided.
    latitude number
    Required only if the geoOverride attribute is set. Latitude with 7 digit precision after decimal point, ranges between -90 and 90 degrees.
    longitude number
    Required only if the geoOverride attribute is set. Longitude with 7 digit precision after decimal point, ranges between -180 and 180 degrees.
    routableIp boolean
    Indicates whether a non-RFC 1918 IP address is publicly routable. This attribute is ignored if there is no ZIA Private Service Edge associated to the organization.
    ip_address str
    The static IP address
    comment str
    Additional information about this static IP address
    geo_override bool
    If not set, geographic coordinates and city are automatically determined from the IP address. Otherwise, the latitude and longitude coordinates must be provided.
    latitude float
    Required only if the geoOverride attribute is set. Latitude with 7 digit precision after decimal point, ranges between -90 and 90 degrees.
    longitude float
    Required only if the geoOverride attribute is set. Longitude with 7 digit precision after decimal point, ranges between -180 and 180 degrees.
    routable_ip bool
    Indicates whether a non-RFC 1918 IP address is publicly routable. This attribute is ignored if there is no ZIA Private Service Edge associated to the organization.
    ipAddress String
    The static IP address
    comment String
    Additional information about this static IP address
    geoOverride Boolean
    If not set, geographic coordinates and city are automatically determined from the IP address. Otherwise, the latitude and longitude coordinates must be provided.
    latitude Number
    Required only if the geoOverride attribute is set. Latitude with 7 digit precision after decimal point, ranges between -90 and 90 degrees.
    longitude Number
    Required only if the geoOverride attribute is set. Longitude with 7 digit precision after decimal point, ranges between -180 and 180 degrees.
    routableIp Boolean
    Indicates whether a non-RFC 1918 IP address is publicly routable. This attribute is ignored if there is no ZIA Private Service Edge associated to the organization.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    StaticIpId int
    The ID of the Static IP.
    Id string
    The provider-assigned unique ID for this managed resource.
    StaticIpId int
    The ID of the Static IP.
    id String
    The provider-assigned unique ID for this managed resource.
    staticIpId Integer
    The ID of the Static IP.
    id string
    The provider-assigned unique ID for this managed resource.
    staticIpId number
    The ID of the Static IP.
    id str
    The provider-assigned unique ID for this managed resource.
    static_ip_id int
    The ID of the Static IP.
    id String
    The provider-assigned unique ID for this managed resource.
    staticIpId Number
    The ID of the Static IP.

    Look up Existing TrafficForwardingStaticIP Resource

    Get an existing TrafficForwardingStaticIP 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?: TrafficForwardingStaticIPState, opts?: CustomResourceOptions): TrafficForwardingStaticIP
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            comment: Optional[str] = None,
            geo_override: Optional[bool] = None,
            ip_address: Optional[str] = None,
            latitude: Optional[float] = None,
            longitude: Optional[float] = None,
            routable_ip: Optional[bool] = None,
            static_ip_id: Optional[int] = None) -> TrafficForwardingStaticIP
    func GetTrafficForwardingStaticIP(ctx *Context, name string, id IDInput, state *TrafficForwardingStaticIPState, opts ...ResourceOption) (*TrafficForwardingStaticIP, error)
    public static TrafficForwardingStaticIP Get(string name, Input<string> id, TrafficForwardingStaticIPState? state, CustomResourceOptions? opts = null)
    public static TrafficForwardingStaticIP get(String name, Output<String> id, TrafficForwardingStaticIPState 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.
    The following state arguments are supported:
    Comment string
    Additional information about this static IP address
    GeoOverride bool
    If not set, geographic coordinates and city are automatically determined from the IP address. Otherwise, the latitude and longitude coordinates must be provided.
    IpAddress string
    The static IP address
    Latitude double
    Required only if the geoOverride attribute is set. Latitude with 7 digit precision after decimal point, ranges between -90 and 90 degrees.
    Longitude double
    Required only if the geoOverride attribute is set. Longitude with 7 digit precision after decimal point, ranges between -180 and 180 degrees.
    RoutableIp bool
    Indicates whether a non-RFC 1918 IP address is publicly routable. This attribute is ignored if there is no ZIA Private Service Edge associated to the organization.
    StaticIpId int
    The ID of the Static IP.
    Comment string
    Additional information about this static IP address
    GeoOverride bool
    If not set, geographic coordinates and city are automatically determined from the IP address. Otherwise, the latitude and longitude coordinates must be provided.
    IpAddress string
    The static IP address
    Latitude float64
    Required only if the geoOverride attribute is set. Latitude with 7 digit precision after decimal point, ranges between -90 and 90 degrees.
    Longitude float64
    Required only if the geoOverride attribute is set. Longitude with 7 digit precision after decimal point, ranges between -180 and 180 degrees.
    RoutableIp bool
    Indicates whether a non-RFC 1918 IP address is publicly routable. This attribute is ignored if there is no ZIA Private Service Edge associated to the organization.
    StaticIpId int
    The ID of the Static IP.
    comment String
    Additional information about this static IP address
    geoOverride Boolean
    If not set, geographic coordinates and city are automatically determined from the IP address. Otherwise, the latitude and longitude coordinates must be provided.
    ipAddress String
    The static IP address
    latitude Double
    Required only if the geoOverride attribute is set. Latitude with 7 digit precision after decimal point, ranges between -90 and 90 degrees.
    longitude Double
    Required only if the geoOverride attribute is set. Longitude with 7 digit precision after decimal point, ranges between -180 and 180 degrees.
    routableIp Boolean
    Indicates whether a non-RFC 1918 IP address is publicly routable. This attribute is ignored if there is no ZIA Private Service Edge associated to the organization.
    staticIpId Integer
    The ID of the Static IP.
    comment string
    Additional information about this static IP address
    geoOverride boolean
    If not set, geographic coordinates and city are automatically determined from the IP address. Otherwise, the latitude and longitude coordinates must be provided.
    ipAddress string
    The static IP address
    latitude number
    Required only if the geoOverride attribute is set. Latitude with 7 digit precision after decimal point, ranges between -90 and 90 degrees.
    longitude number
    Required only if the geoOverride attribute is set. Longitude with 7 digit precision after decimal point, ranges between -180 and 180 degrees.
    routableIp boolean
    Indicates whether a non-RFC 1918 IP address is publicly routable. This attribute is ignored if there is no ZIA Private Service Edge associated to the organization.
    staticIpId number
    The ID of the Static IP.
    comment str
    Additional information about this static IP address
    geo_override bool
    If not set, geographic coordinates and city are automatically determined from the IP address. Otherwise, the latitude and longitude coordinates must be provided.
    ip_address str
    The static IP address
    latitude float
    Required only if the geoOverride attribute is set. Latitude with 7 digit precision after decimal point, ranges between -90 and 90 degrees.
    longitude float
    Required only if the geoOverride attribute is set. Longitude with 7 digit precision after decimal point, ranges between -180 and 180 degrees.
    routable_ip bool
    Indicates whether a non-RFC 1918 IP address is publicly routable. This attribute is ignored if there is no ZIA Private Service Edge associated to the organization.
    static_ip_id int
    The ID of the Static IP.
    comment String
    Additional information about this static IP address
    geoOverride Boolean
    If not set, geographic coordinates and city are automatically determined from the IP address. Otherwise, the latitude and longitude coordinates must be provided.
    ipAddress String
    The static IP address
    latitude Number
    Required only if the geoOverride attribute is set. Latitude with 7 digit precision after decimal point, ranges between -90 and 90 degrees.
    longitude Number
    Required only if the geoOverride attribute is set. Longitude with 7 digit precision after decimal point, ranges between -180 and 180 degrees.
    routableIp Boolean
    Indicates whether a non-RFC 1918 IP address is publicly routable. This attribute is ignored if there is no ZIA Private Service Edge associated to the organization.
    staticIpId Number
    The ID of the Static IP.

    Import

    Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZIA configurations into Terraform-compliant HashiCorp Configuration Language.

    Visit

    Static IP resources can be imported by using <STATIC IP ID> or <IP ADDRESS>as the import ID.

    $ pulumi import zia:index/trafficForwardingStaticIP:TrafficForwardingStaticIP example <static_ip_id>
    

    or

    $ pulumi import zia:index/trafficForwardingStaticIP:TrafficForwardingStaticIP example <ip_address>
    

    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.
    zia logo
    Zscaler Internet Access v0.0.7 published on Tuesday, Jul 30, 2024 by Zscaler