1. Packages
  2. Packages
  3. Checkpoint Provider
  4. API Docs
  5. GaiaScheduledSnapshot
Viewing docs for checkpoint 3.2.0
published on Monday, Jun 15, 2026 by checkpointsw
Viewing docs for checkpoint 3.2.0
published on Monday, Jun 15, 2026 by checkpointsw

    This resource allows you to execute Check Point Scheduled Snapshot.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as checkpoint from "@pulumi/checkpoint";
    
    const example = new checkpoint.GaiaScheduledSnapshot("example", {
        enabled: true,
        namePrefix: "weeklySnap",
        description: "weekly",
        host: {
            target: "lvm",
        },
    });
    
    import pulumi
    import pulumi_checkpoint as checkpoint
    
    example = checkpoint.GaiaScheduledSnapshot("example",
        enabled=True,
        name_prefix="weeklySnap",
        description="weekly",
        host={
            "target": "lvm",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/checkpoint/v3/checkpoint"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := checkpoint.NewGaiaScheduledSnapshot(ctx, "example", &checkpoint.GaiaScheduledSnapshotArgs{
    			Enabled:     pulumi.Bool(true),
    			NamePrefix:  pulumi.String("weeklySnap"),
    			Description: pulumi.String("weekly"),
    			Host: &checkpoint.GaiaScheduledSnapshotHostArgs{
    				Target: pulumi.String("lvm"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Checkpoint = Pulumi.Checkpoint;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Checkpoint.GaiaScheduledSnapshot("example", new()
        {
            Enabled = true,
            NamePrefix = "weeklySnap",
            Description = "weekly",
            Host = new Checkpoint.Inputs.GaiaScheduledSnapshotHostArgs
            {
                Target = "lvm",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.checkpoint.GaiaScheduledSnapshot;
    import com.pulumi.checkpoint.GaiaScheduledSnapshotArgs;
    import com.pulumi.checkpoint.inputs.GaiaScheduledSnapshotHostArgs;
    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 example = new GaiaScheduledSnapshot("example", GaiaScheduledSnapshotArgs.builder()
                .enabled(true)
                .namePrefix("weeklySnap")
                .description("weekly")
                .host(GaiaScheduledSnapshotHostArgs.builder()
                    .target("lvm")
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: checkpoint:GaiaScheduledSnapshot
        properties:
          enabled: true
          namePrefix: weeklySnap
          description: weekly
          host:
            target: lvm
    
    Example coming soon!
    

    Create GaiaScheduledSnapshot Resource

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

    Constructor syntax

    new GaiaScheduledSnapshot(name: string, args?: GaiaScheduledSnapshotArgs, opts?: CustomResourceOptions);
    @overload
    def GaiaScheduledSnapshot(resource_name: str,
                              args: Optional[GaiaScheduledSnapshotArgs] = None,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def GaiaScheduledSnapshot(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              debug: Optional[bool] = None,
                              description: Optional[str] = None,
                              enabled: Optional[bool] = None,
                              gaia_scheduled_snapshot_id: Optional[str] = None,
                              host: Optional[GaiaScheduledSnapshotHostArgs] = None,
                              member_id: Optional[str] = None,
                              name_prefix: Optional[str] = None,
                              recurrence: Optional[GaiaScheduledSnapshotRecurrenceArgs] = None,
                              retention_policy: Optional[GaiaScheduledSnapshotRetentionPolicyArgs] = None)
    func NewGaiaScheduledSnapshot(ctx *Context, name string, args *GaiaScheduledSnapshotArgs, opts ...ResourceOption) (*GaiaScheduledSnapshot, error)
    public GaiaScheduledSnapshot(string name, GaiaScheduledSnapshotArgs? args = null, CustomResourceOptions? opts = null)
    public GaiaScheduledSnapshot(String name, GaiaScheduledSnapshotArgs args)
    public GaiaScheduledSnapshot(String name, GaiaScheduledSnapshotArgs args, CustomResourceOptions options)
    
    type: checkpoint:GaiaScheduledSnapshot
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "checkpoint_gaiascheduledsnapshot" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args GaiaScheduledSnapshotArgs
    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 GaiaScheduledSnapshotArgs
    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 GaiaScheduledSnapshotArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GaiaScheduledSnapshotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GaiaScheduledSnapshotArgs
    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 gaiaScheduledSnapshotResource = new Checkpoint.GaiaScheduledSnapshot("gaiaScheduledSnapshotResource", new()
    {
        Debug = false,
        Description = "string",
        Enabled = false,
        GaiaScheduledSnapshotId = "string",
        Host = new Checkpoint.Inputs.GaiaScheduledSnapshotHostArgs
        {
            IpAddress = "string",
            Password = "string",
            Target = "string",
            UploadPath = "string",
            Username = "string",
        },
        MemberId = "string",
        NamePrefix = "string",
        Recurrence = new Checkpoint.Inputs.GaiaScheduledSnapshotRecurrenceArgs
        {
            Days = new[]
            {
                "string",
            },
            Months = new[]
            {
                "string",
            },
            Pattern = "string",
            Time = new Checkpoint.Inputs.GaiaScheduledSnapshotRecurrenceTimeArgs
            {
                Hour = 0,
                Minute = 0,
            },
            Weekdays = new[]
            {
                "string",
            },
        },
        RetentionPolicy = new Checkpoint.Inputs.GaiaScheduledSnapshotRetentionPolicyArgs
        {
            KeepDiskSpaceAboveInGb = 0,
            MaxSnapshotsToKeep = 0,
            MinSnapshotsToKeep = 0,
        },
    });
    
    example, err := checkpoint.NewGaiaScheduledSnapshot(ctx, "gaiaScheduledSnapshotResource", &checkpoint.GaiaScheduledSnapshotArgs{
    	Debug:                   pulumi.Bool(false),
    	Description:             pulumi.String("string"),
    	Enabled:                 pulumi.Bool(false),
    	GaiaScheduledSnapshotId: pulumi.String("string"),
    	Host: &checkpoint.GaiaScheduledSnapshotHostArgs{
    		IpAddress:  pulumi.String("string"),
    		Password:   pulumi.String("string"),
    		Target:     pulumi.String("string"),
    		UploadPath: pulumi.String("string"),
    		Username:   pulumi.String("string"),
    	},
    	MemberId:   pulumi.String("string"),
    	NamePrefix: pulumi.String("string"),
    	Recurrence: &checkpoint.GaiaScheduledSnapshotRecurrenceArgs{
    		Days: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		Months: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		Pattern: pulumi.String("string"),
    		Time: &checkpoint.GaiaScheduledSnapshotRecurrenceTimeArgs{
    			Hour:   pulumi.Float64(0),
    			Minute: pulumi.Float64(0),
    		},
    		Weekdays: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    	RetentionPolicy: &checkpoint.GaiaScheduledSnapshotRetentionPolicyArgs{
    		KeepDiskSpaceAboveInGb: pulumi.Float64(0),
    		MaxSnapshotsToKeep:     pulumi.Float64(0),
    		MinSnapshotsToKeep:     pulumi.Float64(0),
    	},
    })
    
    resource "checkpoint_gaiascheduledsnapshot" "gaiaScheduledSnapshotResource" {
      debug                      = false
      description                = "string"
      enabled                    = false
      gaia_scheduled_snapshot_id = "string"
      host = {
        ip_address  = "string"
        password    = "string"
        target      = "string"
        upload_path = "string"
        username    = "string"
      }
      member_id   = "string"
      name_prefix = "string"
      recurrence = {
        days    = ["string"]
        months  = ["string"]
        pattern = "string"
        time = {
          hour   = 0
          minute = 0
        }
        weekdays = ["string"]
      }
      retention_policy = {
        keep_disk_space_above_in_gb = 0
        max_snapshots_to_keep       = 0
        min_snapshots_to_keep       = 0
      }
    }
    
    var gaiaScheduledSnapshotResource = new GaiaScheduledSnapshot("gaiaScheduledSnapshotResource", GaiaScheduledSnapshotArgs.builder()
        .debug(false)
        .description("string")
        .enabled(false)
        .gaiaScheduledSnapshotId("string")
        .host(GaiaScheduledSnapshotHostArgs.builder()
            .ipAddress("string")
            .password("string")
            .target("string")
            .uploadPath("string")
            .username("string")
            .build())
        .memberId("string")
        .namePrefix("string")
        .recurrence(GaiaScheduledSnapshotRecurrenceArgs.builder()
            .days("string")
            .months("string")
            .pattern("string")
            .time(GaiaScheduledSnapshotRecurrenceTimeArgs.builder()
                .hour(0.0)
                .minute(0.0)
                .build())
            .weekdays("string")
            .build())
        .retentionPolicy(GaiaScheduledSnapshotRetentionPolicyArgs.builder()
            .keepDiskSpaceAboveInGb(0.0)
            .maxSnapshotsToKeep(0.0)
            .minSnapshotsToKeep(0.0)
            .build())
        .build());
    
    gaia_scheduled_snapshot_resource = checkpoint.GaiaScheduledSnapshot("gaiaScheduledSnapshotResource",
        debug=False,
        description="string",
        enabled=False,
        gaia_scheduled_snapshot_id="string",
        host={
            "ip_address": "string",
            "password": "string",
            "target": "string",
            "upload_path": "string",
            "username": "string",
        },
        member_id="string",
        name_prefix="string",
        recurrence={
            "days": ["string"],
            "months": ["string"],
            "pattern": "string",
            "time": {
                "hour": float(0),
                "minute": float(0),
            },
            "weekdays": ["string"],
        },
        retention_policy={
            "keep_disk_space_above_in_gb": float(0),
            "max_snapshots_to_keep": float(0),
            "min_snapshots_to_keep": float(0),
        })
    
    const gaiaScheduledSnapshotResource = new checkpoint.GaiaScheduledSnapshot("gaiaScheduledSnapshotResource", {
        debug: false,
        description: "string",
        enabled: false,
        gaiaScheduledSnapshotId: "string",
        host: {
            ipAddress: "string",
            password: "string",
            target: "string",
            uploadPath: "string",
            username: "string",
        },
        memberId: "string",
        namePrefix: "string",
        recurrence: {
            days: ["string"],
            months: ["string"],
            pattern: "string",
            time: {
                hour: 0,
                minute: 0,
            },
            weekdays: ["string"],
        },
        retentionPolicy: {
            keepDiskSpaceAboveInGb: 0,
            maxSnapshotsToKeep: 0,
            minSnapshotsToKeep: 0,
        },
    });
    
    type: checkpoint:GaiaScheduledSnapshot
    properties:
        debug: false
        description: string
        enabled: false
        gaiaScheduledSnapshotId: string
        host:
            ipAddress: string
            password: string
            target: string
            uploadPath: string
            username: string
        memberId: string
        namePrefix: string
        recurrence:
            days:
                - string
            months:
                - string
            pattern: string
            time:
                hour: 0
                minute: 0
            weekdays:
                - string
        retentionPolicy:
            keepDiskSpaceAboveInGb: 0
            maxSnapshotsToKeep: 0
            minSnapshotsToKeep: 0
    

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

    Debug bool
    Enable debug logging for this resource.
    Description string
    Description of the scheduled snapshot
    Enabled bool
    State of the snapshot scheduler
    GaiaScheduledSnapshotId string
    Host GaiaScheduledSnapshotHost
    Target host for the snapshots creation host blocks are documented below.
    MemberId string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    NamePrefix string
    Prefix for the snapshots name created by the scheduler
    Recurrence GaiaScheduledSnapshotRecurrence
    Recurrence of the scheduled snapshot recurrence blocks are documented below.
    RetentionPolicy GaiaScheduledSnapshotRetentionPolicy
    Retention-policy for the snapshot scheduler retention_policy blocks are documented below.
    Debug bool
    Enable debug logging for this resource.
    Description string
    Description of the scheduled snapshot
    Enabled bool
    State of the snapshot scheduler
    GaiaScheduledSnapshotId string
    Host GaiaScheduledSnapshotHostArgs
    Target host for the snapshots creation host blocks are documented below.
    MemberId string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    NamePrefix string
    Prefix for the snapshots name created by the scheduler
    Recurrence GaiaScheduledSnapshotRecurrenceArgs
    Recurrence of the scheduled snapshot recurrence blocks are documented below.
    RetentionPolicy GaiaScheduledSnapshotRetentionPolicyArgs
    Retention-policy for the snapshot scheduler retention_policy blocks are documented below.
    debug bool
    Enable debug logging for this resource.
    description string
    Description of the scheduled snapshot
    enabled bool
    State of the snapshot scheduler
    gaia_scheduled_snapshot_id string
    host object
    Target host for the snapshots creation host blocks are documented below.
    member_id string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    name_prefix string
    Prefix for the snapshots name created by the scheduler
    recurrence object
    Recurrence of the scheduled snapshot recurrence blocks are documented below.
    retention_policy object
    Retention-policy for the snapshot scheduler retention_policy blocks are documented below.
    debug Boolean
    Enable debug logging for this resource.
    description String
    Description of the scheduled snapshot
    enabled Boolean
    State of the snapshot scheduler
    gaiaScheduledSnapshotId String
    host GaiaScheduledSnapshotHost
    Target host for the snapshots creation host blocks are documented below.
    memberId String
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    namePrefix String
    Prefix for the snapshots name created by the scheduler
    recurrence GaiaScheduledSnapshotRecurrence
    Recurrence of the scheduled snapshot recurrence blocks are documented below.
    retentionPolicy GaiaScheduledSnapshotRetentionPolicy
    Retention-policy for the snapshot scheduler retention_policy blocks are documented below.
    debug boolean
    Enable debug logging for this resource.
    description string
    Description of the scheduled snapshot
    enabled boolean
    State of the snapshot scheduler
    gaiaScheduledSnapshotId string
    host GaiaScheduledSnapshotHost
    Target host for the snapshots creation host blocks are documented below.
    memberId string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    namePrefix string
    Prefix for the snapshots name created by the scheduler
    recurrence GaiaScheduledSnapshotRecurrence
    Recurrence of the scheduled snapshot recurrence blocks are documented below.
    retentionPolicy GaiaScheduledSnapshotRetentionPolicy
    Retention-policy for the snapshot scheduler retention_policy blocks are documented below.
    debug bool
    Enable debug logging for this resource.
    description str
    Description of the scheduled snapshot
    enabled bool
    State of the snapshot scheduler
    gaia_scheduled_snapshot_id str
    host GaiaScheduledSnapshotHostArgs
    Target host for the snapshots creation host blocks are documented below.
    member_id str
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    name_prefix str
    Prefix for the snapshots name created by the scheduler
    recurrence GaiaScheduledSnapshotRecurrenceArgs
    Recurrence of the scheduled snapshot recurrence blocks are documented below.
    retention_policy GaiaScheduledSnapshotRetentionPolicyArgs
    Retention-policy for the snapshot scheduler retention_policy blocks are documented below.
    debug Boolean
    Enable debug logging for this resource.
    description String
    Description of the scheduled snapshot
    enabled Boolean
    State of the snapshot scheduler
    gaiaScheduledSnapshotId String
    host Property Map
    Target host for the snapshots creation host blocks are documented below.
    memberId String
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    namePrefix String
    Prefix for the snapshots name created by the scheduler
    recurrence Property Map
    Recurrence of the scheduled snapshot recurrence blocks are documented below.
    retentionPolicy Property Map
    Retention-policy for the snapshot scheduler retention_policy blocks are documented below.

    Outputs

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

    Get an existing GaiaScheduledSnapshot 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?: GaiaScheduledSnapshotState, opts?: CustomResourceOptions): GaiaScheduledSnapshot
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            debug: Optional[bool] = None,
            description: Optional[str] = None,
            enabled: Optional[bool] = None,
            gaia_scheduled_snapshot_id: Optional[str] = None,
            host: Optional[GaiaScheduledSnapshotHostArgs] = None,
            member_id: Optional[str] = None,
            name_prefix: Optional[str] = None,
            recurrence: Optional[GaiaScheduledSnapshotRecurrenceArgs] = None,
            retention_policy: Optional[GaiaScheduledSnapshotRetentionPolicyArgs] = None) -> GaiaScheduledSnapshot
    func GetGaiaScheduledSnapshot(ctx *Context, name string, id IDInput, state *GaiaScheduledSnapshotState, opts ...ResourceOption) (*GaiaScheduledSnapshot, error)
    public static GaiaScheduledSnapshot Get(string name, Input<string> id, GaiaScheduledSnapshotState? state, CustomResourceOptions? opts = null)
    public static GaiaScheduledSnapshot get(String name, Output<String> id, GaiaScheduledSnapshotState state, CustomResourceOptions options)
    resources:  _:    type: checkpoint:GaiaScheduledSnapshot    get:      id: ${id}
    import {
      to = checkpoint_gaiascheduledsnapshot.example
      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.
    The following state arguments are supported:
    Debug bool
    Enable debug logging for this resource.
    Description string
    Description of the scheduled snapshot
    Enabled bool
    State of the snapshot scheduler
    GaiaScheduledSnapshotId string
    Host GaiaScheduledSnapshotHost
    Target host for the snapshots creation host blocks are documented below.
    MemberId string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    NamePrefix string
    Prefix for the snapshots name created by the scheduler
    Recurrence GaiaScheduledSnapshotRecurrence
    Recurrence of the scheduled snapshot recurrence blocks are documented below.
    RetentionPolicy GaiaScheduledSnapshotRetentionPolicy
    Retention-policy for the snapshot scheduler retention_policy blocks are documented below.
    Debug bool
    Enable debug logging for this resource.
    Description string
    Description of the scheduled snapshot
    Enabled bool
    State of the snapshot scheduler
    GaiaScheduledSnapshotId string
    Host GaiaScheduledSnapshotHostArgs
    Target host for the snapshots creation host blocks are documented below.
    MemberId string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    NamePrefix string
    Prefix for the snapshots name created by the scheduler
    Recurrence GaiaScheduledSnapshotRecurrenceArgs
    Recurrence of the scheduled snapshot recurrence blocks are documented below.
    RetentionPolicy GaiaScheduledSnapshotRetentionPolicyArgs
    Retention-policy for the snapshot scheduler retention_policy blocks are documented below.
    debug bool
    Enable debug logging for this resource.
    description string
    Description of the scheduled snapshot
    enabled bool
    State of the snapshot scheduler
    gaia_scheduled_snapshot_id string
    host object
    Target host for the snapshots creation host blocks are documented below.
    member_id string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    name_prefix string
    Prefix for the snapshots name created by the scheduler
    recurrence object
    Recurrence of the scheduled snapshot recurrence blocks are documented below.
    retention_policy object
    Retention-policy for the snapshot scheduler retention_policy blocks are documented below.
    debug Boolean
    Enable debug logging for this resource.
    description String
    Description of the scheduled snapshot
    enabled Boolean
    State of the snapshot scheduler
    gaiaScheduledSnapshotId String
    host GaiaScheduledSnapshotHost
    Target host for the snapshots creation host blocks are documented below.
    memberId String
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    namePrefix String
    Prefix for the snapshots name created by the scheduler
    recurrence GaiaScheduledSnapshotRecurrence
    Recurrence of the scheduled snapshot recurrence blocks are documented below.
    retentionPolicy GaiaScheduledSnapshotRetentionPolicy
    Retention-policy for the snapshot scheduler retention_policy blocks are documented below.
    debug boolean
    Enable debug logging for this resource.
    description string
    Description of the scheduled snapshot
    enabled boolean
    State of the snapshot scheduler
    gaiaScheduledSnapshotId string
    host GaiaScheduledSnapshotHost
    Target host for the snapshots creation host blocks are documented below.
    memberId string
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    namePrefix string
    Prefix for the snapshots name created by the scheduler
    recurrence GaiaScheduledSnapshotRecurrence
    Recurrence of the scheduled snapshot recurrence blocks are documented below.
    retentionPolicy GaiaScheduledSnapshotRetentionPolicy
    Retention-policy for the snapshot scheduler retention_policy blocks are documented below.
    debug bool
    Enable debug logging for this resource.
    description str
    Description of the scheduled snapshot
    enabled bool
    State of the snapshot scheduler
    gaia_scheduled_snapshot_id str
    host GaiaScheduledSnapshotHostArgs
    Target host for the snapshots creation host blocks are documented below.
    member_id str
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    name_prefix str
    Prefix for the snapshots name created by the scheduler
    recurrence GaiaScheduledSnapshotRecurrenceArgs
    Recurrence of the scheduled snapshot recurrence blocks are documented below.
    retention_policy GaiaScheduledSnapshotRetentionPolicyArgs
    Retention-policy for the snapshot scheduler retention_policy blocks are documented below.
    debug Boolean
    Enable debug logging for this resource.
    description String
    Description of the scheduled snapshot
    enabled Boolean
    State of the snapshot scheduler
    gaiaScheduledSnapshotId String
    host Property Map
    Target host for the snapshots creation host blocks are documented below.
    memberId String
    Relevant for commands on Scalable and ElasticXL platforms only. When member-id is provided in the login request, show commands during the session will be executed on the specified member, unless a different member-id is provided in a successive requests Set operations will be performed on all members
    namePrefix String
    Prefix for the snapshots name created by the scheduler
    recurrence Property Map
    Recurrence of the scheduled snapshot recurrence blocks are documented below.
    retentionPolicy Property Map
    Retention-policy for the snapshot scheduler retention_policy blocks are documented below.

    Supporting Types

    GaiaScheduledSnapshotHost, GaiaScheduledSnapshotHostArgs

    IpAddress string
    IP-Address of the target
    Password string
    Password for scp/ftp targets
    Target string
    Host target type
    UploadPath string
    Upload path for scp/ftp targets
    Username string
    Username for scp/ftp targets
    IpAddress string
    IP-Address of the target
    Password string
    Password for scp/ftp targets
    Target string
    Host target type
    UploadPath string
    Upload path for scp/ftp targets
    Username string
    Username for scp/ftp targets
    ip_address string
    IP-Address of the target
    password string
    Password for scp/ftp targets
    target string
    Host target type
    upload_path string
    Upload path for scp/ftp targets
    username string
    Username for scp/ftp targets
    ipAddress String
    IP-Address of the target
    password String
    Password for scp/ftp targets
    target String
    Host target type
    uploadPath String
    Upload path for scp/ftp targets
    username String
    Username for scp/ftp targets
    ipAddress string
    IP-Address of the target
    password string
    Password for scp/ftp targets
    target string
    Host target type
    uploadPath string
    Upload path for scp/ftp targets
    username string
    Username for scp/ftp targets
    ip_address str
    IP-Address of the target
    password str
    Password for scp/ftp targets
    target str
    Host target type
    upload_path str
    Upload path for scp/ftp targets
    username str
    Username for scp/ftp targets
    ipAddress String
    IP-Address of the target
    password String
    Password for scp/ftp targets
    target String
    Host target type
    uploadPath String
    Upload path for scp/ftp targets
    username String
    Username for scp/ftp targets

    GaiaScheduledSnapshotRecurrence, GaiaScheduledSnapshotRecurrenceArgs

    Days List<string>
    Recurrence days days blocks are documented below.
    Months List<string>
    Recurrence months months blocks are documented below.
    Pattern string
    Recurrence pattern
    Time GaiaScheduledSnapshotRecurrenceTime
    Recurrence time time blocks are documented below.
    Weekdays List<string>
    Recurrence weekdays weekdays blocks are documented below.
    Days []string
    Recurrence days days blocks are documented below.
    Months []string
    Recurrence months months blocks are documented below.
    Pattern string
    Recurrence pattern
    Time GaiaScheduledSnapshotRecurrenceTime
    Recurrence time time blocks are documented below.
    Weekdays []string
    Recurrence weekdays weekdays blocks are documented below.
    days list(string)
    Recurrence days days blocks are documented below.
    months list(string)
    Recurrence months months blocks are documented below.
    pattern string
    Recurrence pattern
    time object
    Recurrence time time blocks are documented below.
    weekdays list(string)
    Recurrence weekdays weekdays blocks are documented below.
    days List<String>
    Recurrence days days blocks are documented below.
    months List<String>
    Recurrence months months blocks are documented below.
    pattern String
    Recurrence pattern
    time GaiaScheduledSnapshotRecurrenceTime
    Recurrence time time blocks are documented below.
    weekdays List<String>
    Recurrence weekdays weekdays blocks are documented below.
    days string[]
    Recurrence days days blocks are documented below.
    months string[]
    Recurrence months months blocks are documented below.
    pattern string
    Recurrence pattern
    time GaiaScheduledSnapshotRecurrenceTime
    Recurrence time time blocks are documented below.
    weekdays string[]
    Recurrence weekdays weekdays blocks are documented below.
    days Sequence[str]
    Recurrence days days blocks are documented below.
    months Sequence[str]
    Recurrence months months blocks are documented below.
    pattern str
    Recurrence pattern
    time GaiaScheduledSnapshotRecurrenceTime
    Recurrence time time blocks are documented below.
    weekdays Sequence[str]
    Recurrence weekdays weekdays blocks are documented below.
    days List<String>
    Recurrence days days blocks are documented below.
    months List<String>
    Recurrence months months blocks are documented below.
    pattern String
    Recurrence pattern
    time Property Map
    Recurrence time time blocks are documented below.
    weekdays List<String>
    Recurrence weekdays weekdays blocks are documented below.

    GaiaScheduledSnapshotRecurrenceTime, GaiaScheduledSnapshotRecurrenceTimeArgs

    Hour double
    Time hour
    Minute double
    Time minute
    Hour float64
    Time hour
    Minute float64
    Time minute
    hour number
    Time hour
    minute number
    Time minute
    hour Double
    Time hour
    minute Double
    Time minute
    hour number
    Time hour
    minute number
    Time minute
    hour float
    Time hour
    minute float
    Time minute
    hour Number
    Time hour
    minute Number
    Time minute

    GaiaScheduledSnapshotRetentionPolicy, GaiaScheduledSnapshotRetentionPolicyArgs

    KeepDiskSpaceAboveInGb double
    Minimum diskspace to keep on the local machine (GB)
    MaxSnapshotsToKeep double
    Maximum snapshots to keep
    MinSnapshotsToKeep double
    Minimum snapshots to keep
    KeepDiskSpaceAboveInGb float64
    Minimum diskspace to keep on the local machine (GB)
    MaxSnapshotsToKeep float64
    Maximum snapshots to keep
    MinSnapshotsToKeep float64
    Minimum snapshots to keep
    keep_disk_space_above_in_gb number
    Minimum diskspace to keep on the local machine (GB)
    max_snapshots_to_keep number
    Maximum snapshots to keep
    min_snapshots_to_keep number
    Minimum snapshots to keep
    keepDiskSpaceAboveInGb Double
    Minimum diskspace to keep on the local machine (GB)
    maxSnapshotsToKeep Double
    Maximum snapshots to keep
    minSnapshotsToKeep Double
    Minimum snapshots to keep
    keepDiskSpaceAboveInGb number
    Minimum diskspace to keep on the local machine (GB)
    maxSnapshotsToKeep number
    Maximum snapshots to keep
    minSnapshotsToKeep number
    Minimum snapshots to keep
    keep_disk_space_above_in_gb float
    Minimum diskspace to keep on the local machine (GB)
    max_snapshots_to_keep float
    Maximum snapshots to keep
    min_snapshots_to_keep float
    Minimum snapshots to keep
    keepDiskSpaceAboveInGb Number
    Minimum diskspace to keep on the local machine (GB)
    maxSnapshotsToKeep Number
    Maximum snapshots to keep
    minSnapshotsToKeep Number
    Minimum snapshots to keep

    Package Details

    Repository
    checkpoint checkpointsw/terraform-provider-checkpoint
    License
    Notes
    This Pulumi package is based on the checkpoint Terraform Provider.
    Viewing docs for checkpoint 3.2.0
    published on Monday, Jun 15, 2026 by checkpointsw

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial