The zpa_zia_cloud_config resource configures the Zscaler Cloud Sandbox Settings in the Zscaler Private Access cloud. This resource is required when configuring the policy type resource zpa.PolicyAccessCapabilitiesRule.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as zpa from "@bdzscaler/pulumi-zpa";
//######## PASSWORDS IN THIS FILE ARE FAKE AND NOT USED IN PRODUCTION SYSTEMS #########
const _this = new zpa.ZIACloudConfig("this", {
ziaUsername: "",
ziaPassword: "",
ziaCloudServiceApiKey: "",
ziaSandboxApiToken: "",
ziaCloudDomain: "",
});
import pulumi
import zscaler_pulumi_zpa as zpa
######### PASSWORDS IN THIS FILE ARE FAKE AND NOT USED IN PRODUCTION SYSTEMS #########
this = zpa.ZIACloudConfig("this",
zia_username="",
zia_password="",
zia_cloud_service_api_key="",
zia_sandbox_api_token="",
zia_cloud_domain="")
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/zscaler/pulumi-zpa/sdk/go/zpa"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// ######## PASSWORDS IN THIS FILE ARE FAKE AND NOT USED IN PRODUCTION SYSTEMS #########
_, err := zpa.NewZIACloudConfig(ctx, "this", &zpa.ZIACloudConfigArgs{
ZiaUsername: pulumi.String(""),
ZiaPassword: pulumi.String(""),
ZiaCloudServiceApiKey: pulumi.String(""),
ZiaSandboxApiToken: pulumi.String(""),
ZiaCloudDomain: pulumi.String(""),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zpa = zscaler.PulumiPackage.Zpa;
return await Deployment.RunAsync(() =>
{
//######## PASSWORDS IN THIS FILE ARE FAKE AND NOT USED IN PRODUCTION SYSTEMS #########
var @this = new Zpa.ZIACloudConfig("this", new()
{
ZiaUsername = "",
ZiaPassword = "",
ZiaCloudServiceApiKey = "",
ZiaSandboxApiToken = "",
ZiaCloudDomain = "",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zpa.ZIACloudConfig;
import com.pulumi.zpa.ZIACloudConfigArgs;
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 #########
var this_ = new ZIACloudConfig("this", ZIACloudConfigArgs.builder()
.ziaUsername("")
.ziaPassword("")
.ziaCloudServiceApiKey("")
.ziaSandboxApiToken("")
.ziaCloudDomain("")
.build());
}
}
resources:
######### PASSWORDS IN THIS FILE ARE FAKE AND NOT USED IN PRODUCTION SYSTEMS #########
this:
type: zpa:ZIACloudConfig
properties:
ziaUsername: ""
ziaPassword: ""
ziaCloudServiceApiKey: ""
ziaSandboxApiToken: ""
ziaCloudDomain: ""
Create ZIACloudConfig Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ZIACloudConfig(name: string, args: ZIACloudConfigArgs, opts?: CustomResourceOptions);@overload
def ZIACloudConfig(resource_name: str,
args: ZIACloudConfigArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ZIACloudConfig(resource_name: str,
opts: Optional[ResourceOptions] = None,
zia_cloud_domain: Optional[str] = None,
zia_cloud_service_api_key: Optional[str] = None,
zia_password: Optional[str] = None,
zia_sandbox_api_token: Optional[str] = None,
zia_username: Optional[str] = None)func NewZIACloudConfig(ctx *Context, name string, args ZIACloudConfigArgs, opts ...ResourceOption) (*ZIACloudConfig, error)public ZIACloudConfig(string name, ZIACloudConfigArgs args, CustomResourceOptions? opts = null)
public ZIACloudConfig(String name, ZIACloudConfigArgs args)
public ZIACloudConfig(String name, ZIACloudConfigArgs args, CustomResourceOptions options)
type: zpa:ZIACloudConfig
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 ZIACloudConfigArgs
- 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 ZIACloudConfigArgs
- 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 ZIACloudConfigArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ZIACloudConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ZIACloudConfigArgs
- 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 ziacloudConfigResource = new Zpa.ZIACloudConfig("ziacloudConfigResource", new()
{
ZiaCloudDomain = "string",
ZiaCloudServiceApiKey = "string",
ZiaPassword = "string",
ZiaSandboxApiToken = "string",
ZiaUsername = "string",
});
example, err := zpa.NewZIACloudConfig(ctx, "ziacloudConfigResource", &zpa.ZIACloudConfigArgs{
ZiaCloudDomain: pulumi.String("string"),
ZiaCloudServiceApiKey: pulumi.String("string"),
ZiaPassword: pulumi.String("string"),
ZiaSandboxApiToken: pulumi.String("string"),
ZiaUsername: pulumi.String("string"),
})
var ziacloudConfigResource = new ZIACloudConfig("ziacloudConfigResource", ZIACloudConfigArgs.builder()
.ziaCloudDomain("string")
.ziaCloudServiceApiKey("string")
.ziaPassword("string")
.ziaSandboxApiToken("string")
.ziaUsername("string")
.build());
ziacloud_config_resource = zpa.ZIACloudConfig("ziacloudConfigResource",
zia_cloud_domain="string",
zia_cloud_service_api_key="string",
zia_password="string",
zia_sandbox_api_token="string",
zia_username="string")
const ziacloudConfigResource = new zpa.ZIACloudConfig("ziacloudConfigResource", {
ziaCloudDomain: "string",
ziaCloudServiceApiKey: "string",
ziaPassword: "string",
ziaSandboxApiToken: "string",
ziaUsername: "string",
});
type: zpa:ZIACloudConfig
properties:
ziaCloudDomain: string
ziaCloudServiceApiKey: string
ziaPassword: string
ziaSandboxApiToken: string
ziaUsername: string
ZIACloudConfig 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 ZIACloudConfig resource accepts the following input properties:
- Zia
Cloud stringDomain - (String) The supported ZIA cloud name. Supported values are:
- Zia
Cloud stringService Api Key - (String) The ZIA Cloud service api key
- Zia
Password string - (String) The ZIA admin password with permission to use the api key
- Zia
Sandbox stringApi Token - (String) The ZIA Sandbox API token
- Zia
Username string - (String) The ZIA admin username with permission to use the api key
- Zia
Cloud stringDomain - (String) The supported ZIA cloud name. Supported values are:
- Zia
Cloud stringService Api Key - (String) The ZIA Cloud service api key
- Zia
Password string - (String) The ZIA admin password with permission to use the api key
- Zia
Sandbox stringApi Token - (String) The ZIA Sandbox API token
- Zia
Username string - (String) The ZIA admin username with permission to use the api key
- zia
Cloud StringDomain - (String) The supported ZIA cloud name. Supported values are:
- zia
Cloud StringService Api Key - (String) The ZIA Cloud service api key
- zia
Password String - (String) The ZIA admin password with permission to use the api key
- zia
Sandbox StringApi Token - (String) The ZIA Sandbox API token
- zia
Username String - (String) The ZIA admin username with permission to use the api key
- zia
Cloud stringDomain - (String) The supported ZIA cloud name. Supported values are:
- zia
Cloud stringService Api Key - (String) The ZIA Cloud service api key
- zia
Password string - (String) The ZIA admin password with permission to use the api key
- zia
Sandbox stringApi Token - (String) The ZIA Sandbox API token
- zia
Username string - (String) The ZIA admin username with permission to use the api key
- zia_
cloud_ strdomain - (String) The supported ZIA cloud name. Supported values are:
- zia_
cloud_ strservice_ api_ key - (String) The ZIA Cloud service api key
- zia_
password str - (String) The ZIA admin password with permission to use the api key
- zia_
sandbox_ strapi_ token - (String) The ZIA Sandbox API token
- zia_
username str - (String) The ZIA admin username with permission to use the api key
- zia
Cloud StringDomain - (String) The supported ZIA cloud name. Supported values are:
- zia
Cloud StringService Api Key - (String) The ZIA Cloud service api key
- zia
Password String - (String) The ZIA admin password with permission to use the api key
- zia
Sandbox StringApi Token - (String) The ZIA Sandbox API token
- zia
Username String - (String) The ZIA admin username with permission to use the api key
Outputs
All input properties are implicitly available as output properties. Additionally, the ZIACloudConfig 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 ZIACloudConfig Resource
Get an existing ZIACloudConfig 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?: ZIACloudConfigState, opts?: CustomResourceOptions): ZIACloudConfig@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
zia_cloud_domain: Optional[str] = None,
zia_cloud_service_api_key: Optional[str] = None,
zia_password: Optional[str] = None,
zia_sandbox_api_token: Optional[str] = None,
zia_username: Optional[str] = None) -> ZIACloudConfigfunc GetZIACloudConfig(ctx *Context, name string, id IDInput, state *ZIACloudConfigState, opts ...ResourceOption) (*ZIACloudConfig, error)public static ZIACloudConfig Get(string name, Input<string> id, ZIACloudConfigState? state, CustomResourceOptions? opts = null)public static ZIACloudConfig get(String name, Output<String> id, ZIACloudConfigState state, CustomResourceOptions options)resources: _: type: zpa:ZIACloudConfig 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.
- Zia
Cloud stringDomain - (String) The supported ZIA cloud name. Supported values are:
- Zia
Cloud stringService Api Key - (String) The ZIA Cloud service api key
- Zia
Password string - (String) The ZIA admin password with permission to use the api key
- Zia
Sandbox stringApi Token - (String) The ZIA Sandbox API token
- Zia
Username string - (String) The ZIA admin username with permission to use the api key
- Zia
Cloud stringDomain - (String) The supported ZIA cloud name. Supported values are:
- Zia
Cloud stringService Api Key - (String) The ZIA Cloud service api key
- Zia
Password string - (String) The ZIA admin password with permission to use the api key
- Zia
Sandbox stringApi Token - (String) The ZIA Sandbox API token
- Zia
Username string - (String) The ZIA admin username with permission to use the api key
- zia
Cloud StringDomain - (String) The supported ZIA cloud name. Supported values are:
- zia
Cloud StringService Api Key - (String) The ZIA Cloud service api key
- zia
Password String - (String) The ZIA admin password with permission to use the api key
- zia
Sandbox StringApi Token - (String) The ZIA Sandbox API token
- zia
Username String - (String) The ZIA admin username with permission to use the api key
- zia
Cloud stringDomain - (String) The supported ZIA cloud name. Supported values are:
- zia
Cloud stringService Api Key - (String) The ZIA Cloud service api key
- zia
Password string - (String) The ZIA admin password with permission to use the api key
- zia
Sandbox stringApi Token - (String) The ZIA Sandbox API token
- zia
Username string - (String) The ZIA admin username with permission to use the api key
- zia_
cloud_ strdomain - (String) The supported ZIA cloud name. Supported values are:
- zia_
cloud_ strservice_ api_ key - (String) The ZIA Cloud service api key
- zia_
password str - (String) The ZIA admin password with permission to use the api key
- zia_
sandbox_ strapi_ token - (String) The ZIA Sandbox API token
- zia_
username str - (String) The ZIA admin username with permission to use the api key
- zia
Cloud StringDomain - (String) The supported ZIA cloud name. Supported values are:
- zia
Cloud StringService Api Key - (String) The ZIA Cloud service api key
- zia
Password String - (String) The ZIA admin password with permission to use the api key
- zia
Sandbox StringApi Token - (String) The ZIA Sandbox API token
- zia
Username String - (String) The ZIA admin username with permission to use the api key
Import
Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language.
Visit
zpa_zia_cloud_config can be imported by using <ZIA_CLOUD_CONFIG> as the import ID.
For example:
$ pulumi import zpa:index/zIACloudConfig:ZIACloudConfig example <zia_cloud_config>
or
$ pulumi import zpa:index/zIACloudConfig:ZIACloudConfig example <zia_cloud_config>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- zpa zscaler/pulumi-zpa
- License
- MIT
- Notes
- This Pulumi package is based on the
zpaTerraform Provider.
