1. Packages
  2. Zscaler Private Access (ZPA)
  3. API Docs
  4. AssistantSchedule
Zscaler Private Access v0.0.11 published on Saturday, May 4, 2024 by Zscaler

zpa.AssistantSchedule

Explore with Pulumi AI

zpa logo
Zscaler Private Access v0.0.11 published on Saturday, May 4, 2024 by Zscaler

    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.AssistantSchedule("this", {
        customerId: "123456789101112",
        deleteDisabled: true,
        enabled: true,
        frequency: "days",
        frequencyInterval: "5",
    });
    
    import pulumi
    import zscaler_pulumi_zpa as zpa
    
    this = zpa.AssistantSchedule("this",
        customer_id="123456789101112",
        delete_disabled=True,
        enabled=True,
        frequency="days",
        frequency_interval="5")
    
    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.NewAssistantSchedule(ctx, "this", &zpa.AssistantScheduleArgs{
    			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
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Zpa = Zscaler.Zpa;
    
    return await Deployment.RunAsync(() => 
    {
        var @this = new Zpa.AssistantSchedule("this", new()
        {
            CustomerId = "123456789101112",
            DeleteDisabled = true,
            Enabled = true,
            Frequency = "days",
            FrequencyInterval = "5",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.zpa.AssistantSchedule;
    import com.pulumi.zpa.AssistantScheduleArgs;
    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 AssistantSchedule("this", AssistantScheduleArgs.builder()        
                .customerId("123456789101112")
                .deleteDisabled(true)
                .enabled(true)
                .frequency("days")
                .frequencyInterval("5")
                .build());
    
        }
    }
    
    resources:
      this:
        type: zpa:AssistantSchedule
        properties:
          customerId: '123456789101112'
          deleteDisabled: true
          enabled: true
          frequency: days
          frequencyInterval: '5'
    

    Customer ID Via Environment Variable

    import * as pulumi from "@pulumi/pulumi";
    import * as zpa from "@bdzscaler/pulumi-zpa";
    
    const _this = new zpa.AssistantSchedule("this", {
        deleteDisabled: true,
        enabled: true,
        frequency: "days",
        frequencyInterval: "5",
    });
    
    import pulumi
    import zscaler_pulumi_zpa as zpa
    
    this = zpa.AssistantSchedule("this",
        delete_disabled=True,
        enabled=True,
        frequency="days",
        frequency_interval="5")
    
    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.NewAssistantSchedule(ctx, "this", &zpa.AssistantScheduleArgs{
    			DeleteDisabled:    pulumi.Bool(true),
    			Enabled:           pulumi.Bool(true),
    			Frequency:         pulumi.String("days"),
    			FrequencyInterval: pulumi.String("5"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Zpa = Zscaler.Zpa;
    
    return await Deployment.RunAsync(() => 
    {
        var @this = new Zpa.AssistantSchedule("this", new()
        {
            DeleteDisabled = true,
            Enabled = true,
            Frequency = "days",
            FrequencyInterval = "5",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.zpa.AssistantSchedule;
    import com.pulumi.zpa.AssistantScheduleArgs;
    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 AssistantSchedule("this", AssistantScheduleArgs.builder()        
                .deleteDisabled(true)
                .enabled(true)
                .frequency("days")
                .frequencyInterval("5")
                .build());
    
        }
    }
    
    resources:
      this:
        type: zpa:AssistantSchedule
        properties:
          deleteDisabled: true
          enabled: true
          frequency: days
          frequencyInterval: '5'
    

    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 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 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 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 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 String
    The unique name of the resource.
    args AssistantScheduleArgs
    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 assistantScheduleResource = new Zpa.AssistantSchedule("assistantScheduleResource", new()
    {
        CustomerId = "string",
        DeleteDisabled = false,
        Enabled = false,
        Frequency = "string",
        FrequencyInterval = "string",
    });
    
    example, err := zpa.NewAssistantSchedule(ctx, "assistantScheduleResource", &zpa.AssistantScheduleArgs{
    	CustomerId:        pulumi.String("string"),
    	DeleteDisabled:    pulumi.Bool(false),
    	Enabled:           pulumi.Bool(false),
    	Frequency:         pulumi.String("string"),
    	FrequencyInterval: pulumi.String("string"),
    })
    
    var assistantScheduleResource = new AssistantSchedule("assistantScheduleResource", AssistantScheduleArgs.builder()
        .customerId("string")
        .deleteDisabled(false)
        .enabled(false)
        .frequency("string")
        .frequencyInterval("string")
        .build());
    
    assistant_schedule_resource = zpa.AssistantSchedule("assistantScheduleResource",
        customer_id="string",
        delete_disabled=False,
        enabled=False,
        frequency="string",
        frequency_interval="string")
    
    const assistantScheduleResource = new zpa.AssistantSchedule("assistantScheduleResource", {
        customerId: "string",
        deleteDisabled: false,
        enabled: false,
        frequency: "string",
        frequencyInterval: "string",
    });
    
    type: zpa:AssistantSchedule
    properties:
        customerId: string
        deleteDisabled: false
        enabled: false
        frequency: string
        frequencyInterval: string
    

    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

    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)
    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:

    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.
    zpa logo
    Zscaler Private Access v0.0.11 published on Saturday, May 4, 2024 by Zscaler