@bdzscaler/pulumi-zia
Version:
A Pulumi package for creating and managing zia cloud resources.
159 lines (158 loc) • 6.28 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* * [Official documentation](https://help.zscaler.com/zia/about-static-ip)
* * [API documentation](https://help.zscaler.com/zia/traffic-forwarding-0#/staticIP-get)
*
* 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
*
* 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.
*
* ```sh
* $ pulumi import zia:index/trafficForwardingStaticIP:TrafficForwardingStaticIP example <static_ip_id>
* ```
*
* or
*
* ```sh
* $ pulumi import zia:index/trafficForwardingStaticIP:TrafficForwardingStaticIP example <ip_address>
* ```
*/
export declare class TrafficForwardingStaticIP extends pulumi.CustomResource {
/**
* Get an existing TrafficForwardingStaticIP resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TrafficForwardingStaticIPState, opts?: pulumi.CustomResourceOptions): TrafficForwardingStaticIP;
/**
* Returns true if the given object is an instance of TrafficForwardingStaticIP. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is TrafficForwardingStaticIP;
/**
* Additional information about this static IP address
*/
readonly comment: pulumi.Output<string>;
/**
* If not set, geographic coordinates and city are automatically determined from the IP address. Otherwise, the latitude
* and longitude coordinates must be provided.
*/
readonly geoOverride: pulumi.Output<boolean>;
/**
* The static IP address
*/
readonly ipAddress: pulumi.Output<string>;
/**
* Required only if the geoOverride attribute is set. Latitude with 7 digit precision after decimal point, ranges between
* -90 and 90 degrees.
*/
readonly latitude: pulumi.Output<number>;
/**
* Required only if the geoOverride attribute is set. Longitude with 7 digit precision after decimal point, ranges between
* -180 and 180 degrees.
*/
readonly longitude: pulumi.Output<number>;
/**
* 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.
*/
readonly routableIp: pulumi.Output<boolean>;
/**
* The ID of the Static IP.
*/
readonly staticIpId: pulumi.Output<number>;
/**
* Create a TrafficForwardingStaticIP resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: TrafficForwardingStaticIPArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering TrafficForwardingStaticIP resources.
*/
export interface TrafficForwardingStaticIPState {
/**
* Additional information about this static IP address
*/
comment?: pulumi.Input<string>;
/**
* If not set, geographic coordinates and city are automatically determined from the IP address. Otherwise, the latitude
* and longitude coordinates must be provided.
*/
geoOverride?: pulumi.Input<boolean>;
/**
* The static IP address
*/
ipAddress?: pulumi.Input<string>;
/**
* Required only if the geoOverride attribute is set. Latitude with 7 digit precision after decimal point, ranges between
* -90 and 90 degrees.
*/
latitude?: pulumi.Input<number>;
/**
* Required only if the geoOverride attribute is set. Longitude with 7 digit precision after decimal point, ranges between
* -180 and 180 degrees.
*/
longitude?: pulumi.Input<number>;
/**
* 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.
*/
routableIp?: pulumi.Input<boolean>;
/**
* The ID of the Static IP.
*/
staticIpId?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a TrafficForwardingStaticIP resource.
*/
export interface TrafficForwardingStaticIPArgs {
/**
* Additional information about this static IP address
*/
comment?: pulumi.Input<string>;
/**
* If not set, geographic coordinates and city are automatically determined from the IP address. Otherwise, the latitude
* and longitude coordinates must be provided.
*/
geoOverride?: pulumi.Input<boolean>;
/**
* The static IP address
*/
ipAddress: pulumi.Input<string>;
/**
* Required only if the geoOverride attribute is set. Latitude with 7 digit precision after decimal point, ranges between
* -90 and 90 degrees.
*/
latitude?: pulumi.Input<number>;
/**
* Required only if the geoOverride attribute is set. Longitude with 7 digit precision after decimal point, ranges between
* -180 and 180 degrees.
*/
longitude?: pulumi.Input<number>;
/**
* 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.
*/
routableIp?: pulumi.Input<boolean>;
}