1. Packages
  2. Zscaler Private Access (ZPA)
  3. API Docs
  4. AssistantSchedule
Zscaler Private Access v0.0.12 published on Tuesday, Jul 30, 2024 by Zscaler

zpa.AssistantSchedule

Explore with Pulumi AI

Deprecated: zpa.index/assistantschedule.AssistantSchedule has been deprecated in favor of zpa.index/appconnectorassistantschedule.AppConnectorAssistantSchedule

Use the zpa_app_connector_assistant_schedule resource sets the scheduled frequency at which the disconnected App Connectors are eligible for deletion. The supported value for frequency is days. The frequencyInterval field is the number of days after an App Connector disconnects for it to become eligible for deletion. The minimum supported value for frequencyInterval is 5.

NOTE - When enabling the Assistant Schedule for the first time, you must provide the customer_id information. If you authenticated using environment variables and used ZPA_CUSTOMER_ID environment variable, you don’t have to define the customer_id attribute in the HCL configuration, and the provider will automatically use the value from the environment variable ZPA_CUSTOMER_ID

Example Usage

Defined Customer ID Value

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

const _this = new zpa.AppConnectorAssistantSchedule("this", {
    customerId: "123456789101112",
    deleteDisabled: true,
    enabled: true,
    frequency: "days",
    frequencyInterval: "5",
});
Copy
import pulumi
import zscaler_pulumi_zpa as zpa

this = zpa.AppConnectorAssistantSchedule("this",
    customer_id="123456789101112",
    delete_disabled=True,
    enabled=True,
    frequency="days",
    frequency_interval="5")
Copy
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 {
		_, err := zpa.NewAppConnectorAssistantSchedule(ctx, "this", &zpa.AppConnectorAssistantScheduleArgs{
			CustomerId:        pulumi.String("123456789101112"),
			DeleteDisabled:    pulumi.Bool(true),
			Enabled:           pulumi.Bool(true),
			Frequency:         pulumi.String("days"),
			FrequencyInterval: pulumi.String("5"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zpa = Zscaler.Zpa;

return await Deployment.RunAsync(() => 
{
    var @this = new Zpa.AppConnectorAssistantSchedule("this", new()
    {
        CustomerId = "123456789101112",
        DeleteDisabled = true,
        Enabled = true,
        Frequency = "days",
        FrequencyInterval = "5",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zpa.AppConnectorAssistantSchedule;
import com.pulumi.zpa.AppConnectorAssistantScheduleArgs;
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 this_ = new AppConnectorAssistantSchedule("this", AppConnectorAssistantScheduleArgs.builder()
            .customerId("123456789101112")
            .deleteDisabled(true)
            .enabled(true)
            .frequency("days")
            .frequencyInterval("5")
            .build());

    }
}
Copy
resources:
  this:
    type: zpa:AppConnectorAssistantSchedule
    properties:
      customerId: '123456789101112'
      deleteDisabled: true
      enabled: true
      frequency: days
      frequencyInterval: '5'
Copy

Customer ID Via Environment Variable

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

const _this = new zpa.AppConnectorAssistantSchedule("this", {
    deleteDisabled: true,
    enabled: true,
    frequency: "days",
    frequencyInterval: "5",
});
Copy
import pulumi
import zscaler_pulumi_zpa as zpa

this = zpa.AppConnectorAssistantSchedule("this",
    delete_disabled=True,
    enabled=True,
    frequency="days",
    frequency_interval="5")
Copy
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 {
		_, err := zpa.NewAppConnectorAssistantSchedule(ctx, "this", &zpa.AppConnectorAssistantScheduleArgs{
			DeleteDisabled:    pulumi.Bool(true),
			Enabled:           pulumi.Bool(true),
			Frequency:         pulumi.String("days"),
			FrequencyInterval: pulumi.String("5"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zpa = Zscaler.Zpa;

return await Deployment.RunAsync(() => 
{
    var @this = new Zpa.AppConnectorAssistantSchedule("this", new()
    {
        DeleteDisabled = true,
        Enabled = true,
        Frequency = "days",
        FrequencyInterval = "5",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zpa.AppConnectorAssistantSchedule;
import com.pulumi.zpa.AppConnectorAssistantScheduleArgs;
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 this_ = new AppConnectorAssistantSchedule("this", AppConnectorAssistantScheduleArgs.builder()
            .deleteDisabled(true)
            .enabled(true)
            .frequency("days")
            .frequencyInterval("5")
            .build());

    }
}
Copy
resources:
  this:
    type: zpa:AppConnectorAssistantSchedule
    properties:
      deleteDisabled: true
      enabled: true
      frequency: days
      frequencyInterval: '5'
Copy

Create AssistantSchedule Resource

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

Constructor syntax

new AssistantSchedule(name: string, args?: AssistantScheduleArgs, opts?: CustomResourceOptions);
@overload
def AssistantSchedule(resource_name: str,
                      args: Optional[AssistantScheduleArgs] = None,
                      opts: Optional[ResourceOptions] = None)

@overload
def AssistantSchedule(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      customer_id: Optional[str] = None,
                      delete_disabled: Optional[bool] = None,
                      enabled: Optional[bool] = None,
                      frequency: Optional[str] = None,
                      frequency_interval: Optional[str] = None)
func NewAssistantSchedule(ctx *Context, name string, args *AssistantScheduleArgs, opts ...ResourceOption) (*AssistantSchedule, error)
public AssistantSchedule(string name, AssistantScheduleArgs? args = null, CustomResourceOptions? opts = null)
public AssistantSchedule(String name, AssistantScheduleArgs args)
public AssistantSchedule(String name, AssistantScheduleArgs args, CustomResourceOptions options)
type: zpa:AssistantSchedule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args AssistantScheduleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args AssistantScheduleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args AssistantScheduleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args AssistantScheduleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AssistantScheduleArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

Outputs

All input properties are implicitly available as output properties. Additionally, the AssistantSchedule 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 AssistantSchedule Resource

Get an existing AssistantSchedule 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?: AssistantScheduleState, opts?: CustomResourceOptions): AssistantSchedule
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        customer_id: Optional[str] = None,
        delete_disabled: Optional[bool] = None,
        enabled: Optional[bool] = None,
        frequency: Optional[str] = None,
        frequency_interval: Optional[str] = None) -> AssistantSchedule
func GetAssistantSchedule(ctx *Context, name string, id IDInput, state *AssistantScheduleState, opts ...ResourceOption) (*AssistantSchedule, error)
public static AssistantSchedule Get(string name, Input<string> id, AssistantScheduleState? state, CustomResourceOptions? opts = null)
public static AssistantSchedule get(String name, Output<String> id, AssistantScheduleState state, CustomResourceOptions options)
resources:  _:    type: zpa:AssistantSchedule    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:

Import

Import is not currently supported for this resource.

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 zpa Terraform Provider.