Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Checkpoint Provider
  3. API Docs
  4. ManagementSetAutomaticPurge
checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw
checkpointsw/terraform-provider-checkpoint

checkpoint.ManagementSetAutomaticPurge

Explore with Pulumi AI

checkpoint logo
checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw
checkpointsw/terraform-provider-checkpoint

    This command resource allows you to execute Check Point Set Automatic Purge.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as checkpoint from "@pulumi/checkpoint";

const example = new checkpoint.ManagementSetAutomaticPurge("example", {
    enabled: true,
    keepSessionsByDays: false,
    numberOfSessionsToKeep: 10,
});

    import pulumi
import pulumi_checkpoint as checkpoint

example = checkpoint.ManagementSetAutomaticPurge("example",
    enabled=True,
    keep_sessions_by_days=False,
    number_of_sessions_to_keep=10)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/checkpoint/v2/checkpoint"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := checkpoint.NewManagementSetAutomaticPurge(ctx, "example", &checkpoint.ManagementSetAutomaticPurgeArgs{
			Enabled:                pulumi.Bool(true),
			KeepSessionsByDays:     pulumi.Bool(false),
			NumberOfSessionsToKeep: pulumi.Float64(10),
		})
		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.ManagementSetAutomaticPurge("example", new()
    {
        Enabled = true,
        KeepSessionsByDays = false,
        NumberOfSessionsToKeep = 10,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.checkpoint.ManagementSetAutomaticPurge;
import com.pulumi.checkpoint.ManagementSetAutomaticPurgeArgs;
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 ManagementSetAutomaticPurge("example", ManagementSetAutomaticPurgeArgs.builder()
            .enabled(true)
            .keepSessionsByDays(false)
            .numberOfSessionsToKeep(10)
            .build());

    }
}

    resources:
  example:
    type: checkpoint:ManagementSetAutomaticPurge
    properties:
      enabled: true
      keepSessionsByDays: false
      numberOfSessionsToKeep: 10

    How To Use

    Make sure this command will be executed in the right execution order.

    Create ManagementSetAutomaticPurge Resource

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

    Constructor syntax

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

@overload
def ManagementSetAutomaticPurge(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                enabled: Optional[bool] = None,
                                keep_sessions_by_count: Optional[bool] = None,
                                keep_sessions_by_days: Optional[bool] = None,
                                management_set_automatic_purge_id: Optional[str] = None,
                                number_of_days_to_keep: Optional[float] = None,
                                number_of_sessions_to_keep: Optional[float] = None,
                                scheduling: Optional[Mapping[str, str]] = None)
    func NewManagementSetAutomaticPurge(ctx *Context, name string, args ManagementSetAutomaticPurgeArgs, opts ...ResourceOption) (*ManagementSetAutomaticPurge, error)
    public ManagementSetAutomaticPurge(string name, ManagementSetAutomaticPurgeArgs args, CustomResourceOptions? opts = null)
    public ManagementSetAutomaticPurge(String name, ManagementSetAutomaticPurgeArgs args)
public ManagementSetAutomaticPurge(String name, ManagementSetAutomaticPurgeArgs args, CustomResourceOptions options)

    type: checkpoint:ManagementSetAutomaticPurge
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 ManagementSetAutomaticPurgeArgs
    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 ManagementSetAutomaticPurgeArgs
    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 ManagementSetAutomaticPurgeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ManagementSetAutomaticPurgeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ManagementSetAutomaticPurgeArgs
    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 managementSetAutomaticPurgeResource = new Checkpoint.ManagementSetAutomaticPurge("managementSetAutomaticPurgeResource", new()
{
    Enabled = false,
    KeepSessionsByCount = false,
    KeepSessionsByDays = false,
    ManagementSetAutomaticPurgeId = "string",
    NumberOfDaysToKeep = 0,
    NumberOfSessionsToKeep = 0,
    Scheduling = 
    {
        { "string", "string" },
    },
});

    example, err := checkpoint.NewManagementSetAutomaticPurge(ctx, "managementSetAutomaticPurgeResource", &checkpoint.ManagementSetAutomaticPurgeArgs{
	Enabled:                       pulumi.Bool(false),
	KeepSessionsByCount:           pulumi.Bool(false),
	KeepSessionsByDays:            pulumi.Bool(false),
	ManagementSetAutomaticPurgeId: pulumi.String("string"),
	NumberOfDaysToKeep:            pulumi.Float64(0),
	NumberOfSessionsToKeep:        pulumi.Float64(0),
	Scheduling: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var managementSetAutomaticPurgeResource = new ManagementSetAutomaticPurge("managementSetAutomaticPurgeResource", ManagementSetAutomaticPurgeArgs.builder()
    .enabled(false)
    .keepSessionsByCount(false)
    .keepSessionsByDays(false)
    .managementSetAutomaticPurgeId("string")
    .numberOfDaysToKeep(0)
    .numberOfSessionsToKeep(0)
    .scheduling(Map.of("string", "string"))
    .build());

    management_set_automatic_purge_resource = checkpoint.ManagementSetAutomaticPurge("managementSetAutomaticPurgeResource",
    enabled=False,
    keep_sessions_by_count=False,
    keep_sessions_by_days=False,
    management_set_automatic_purge_id="string",
    number_of_days_to_keep=0,
    number_of_sessions_to_keep=0,
    scheduling={
        "string": "string",
    })

    const managementSetAutomaticPurgeResource = new checkpoint.ManagementSetAutomaticPurge("managementSetAutomaticPurgeResource", {
    enabled: false,
    keepSessionsByCount: false,
    keepSessionsByDays: false,
    managementSetAutomaticPurgeId: "string",
    numberOfDaysToKeep: 0,
    numberOfSessionsToKeep: 0,
    scheduling: {
        string: "string",
    },
});

    type: checkpoint:ManagementSetAutomaticPurge
properties:
    enabled: false
    keepSessionsByCount: false
    keepSessionsByDays: false
    managementSetAutomaticPurgeId: string
    numberOfDaysToKeep: 0
    numberOfSessionsToKeep: 0
    scheduling:
        string: string

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

    Enabled bool
    Turn on/off the automatic-purge feature.
    KeepSessionsByCount bool
    Whether or not to keep the latest N sessions. Note: when the automatic purge feature is enabled, this field and/or the "keep-sessions-by-date" field must be set to 'true'.
    KeepSessionsByDays bool
    Whether or not to keep the sessions for D days. Note: when the automatic purge feature is enabled, this field and/or the "keep-sessions-by-count" field must be set to 'true'.
    ManagementSetAutomaticPurgeId string
    NumberOfDaysToKeep double
    When "keep-sessions-by-days = true" this sets the number of days to keep the sessions.
    NumberOfSessionsToKeep double
    When "keep-sessions-by-count = true" this sets the number of newest sessions to preserve, by the sessions's publish date.
    Scheduling Dictionary<string, string>
    When to purge sessions that do not meet the "keep" criteria. Note: when the automatic purge feature is enabled, this field must be set.scheduling blocks are documented below.
    Enabled bool
    Turn on/off the automatic-purge feature.
    KeepSessionsByCount bool
    Whether or not to keep the latest N sessions. Note: when the automatic purge feature is enabled, this field and/or the "keep-sessions-by-date" field must be set to 'true'.
    KeepSessionsByDays bool
    Whether or not to keep the sessions for D days. Note: when the automatic purge feature is enabled, this field and/or the "keep-sessions-by-count" field must be set to 'true'.
    ManagementSetAutomaticPurgeId string
    NumberOfDaysToKeep float64
    When "keep-sessions-by-days = true" this sets the number of days to keep the sessions.
    NumberOfSessionsToKeep float64
    When "keep-sessions-by-count = true" this sets the number of newest sessions to preserve, by the sessions's publish date.
    Scheduling map[string]string
    When to purge sessions that do not meet the "keep" criteria. Note: when the automatic purge feature is enabled, this field must be set.scheduling blocks are documented below.
    enabled Boolean
    Turn on/off the automatic-purge feature.
    keepSessionsByCount Boolean
    Whether or not to keep the latest N sessions. Note: when the automatic purge feature is enabled, this field and/or the "keep-sessions-by-date" field must be set to 'true'.
    keepSessionsByDays Boolean
    Whether or not to keep the sessions for D days. Note: when the automatic purge feature is enabled, this field and/or the "keep-sessions-by-count" field must be set to 'true'.
    managementSetAutomaticPurgeId String
    numberOfDaysToKeep Double
    When "keep-sessions-by-days = true" this sets the number of days to keep the sessions.
    numberOfSessionsToKeep Double
    When "keep-sessions-by-count = true" this sets the number of newest sessions to preserve, by the sessions's publish date.
    scheduling Map<String,String>
    When to purge sessions that do not meet the "keep" criteria. Note: when the automatic purge feature is enabled, this field must be set.scheduling blocks are documented below.
    enabled boolean
    Turn on/off the automatic-purge feature.
    keepSessionsByCount boolean
    Whether or not to keep the latest N sessions. Note: when the automatic purge feature is enabled, this field and/or the "keep-sessions-by-date" field must be set to 'true'.
    keepSessionsByDays boolean
    Whether or not to keep the sessions for D days. Note: when the automatic purge feature is enabled, this field and/or the "keep-sessions-by-count" field must be set to 'true'.
    managementSetAutomaticPurgeId string
    numberOfDaysToKeep number
    When "keep-sessions-by-days = true" this sets the number of days to keep the sessions.
    numberOfSessionsToKeep number
    When "keep-sessions-by-count = true" this sets the number of newest sessions to preserve, by the sessions's publish date.
    scheduling {[key: string]: string}
    When to purge sessions that do not meet the "keep" criteria. Note: when the automatic purge feature is enabled, this field must be set.scheduling blocks are documented below.
    enabled bool
    Turn on/off the automatic-purge feature.
    keep_sessions_by_count bool
    Whether or not to keep the latest N sessions. Note: when the automatic purge feature is enabled, this field and/or the "keep-sessions-by-date" field must be set to 'true'.
    keep_sessions_by_days bool
    Whether or not to keep the sessions for D days. Note: when the automatic purge feature is enabled, this field and/or the "keep-sessions-by-count" field must be set to 'true'.
    management_set_automatic_purge_id str
    number_of_days_to_keep float
    When "keep-sessions-by-days = true" this sets the number of days to keep the sessions.
    number_of_sessions_to_keep float
    When "keep-sessions-by-count = true" this sets the number of newest sessions to preserve, by the sessions's publish date.
    scheduling Mapping[str, str]
    When to purge sessions that do not meet the "keep" criteria. Note: when the automatic purge feature is enabled, this field must be set.scheduling blocks are documented below.
    enabled Boolean
    Turn on/off the automatic-purge feature.
    keepSessionsByCount Boolean
    Whether or not to keep the latest N sessions. Note: when the automatic purge feature is enabled, this field and/or the "keep-sessions-by-date" field must be set to 'true'.
    keepSessionsByDays Boolean
    Whether or not to keep the sessions for D days. Note: when the automatic purge feature is enabled, this field and/or the "keep-sessions-by-count" field must be set to 'true'.
    managementSetAutomaticPurgeId String
    numberOfDaysToKeep Number
    When "keep-sessions-by-days = true" this sets the number of days to keep the sessions.
    numberOfSessionsToKeep Number
    When "keep-sessions-by-count = true" this sets the number of newest sessions to preserve, by the sessions's publish date.
    scheduling Map<String>
    When to purge sessions that do not meet the "keep" criteria. Note: when the automatic purge feature is enabled, this field must be set.scheduling blocks are documented below.

    Outputs

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

    Get an existing ManagementSetAutomaticPurge 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?: ManagementSetAutomaticPurgeState, opts?: CustomResourceOptions): ManagementSetAutomaticPurge
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enabled: Optional[bool] = None,
        keep_sessions_by_count: Optional[bool] = None,
        keep_sessions_by_days: Optional[bool] = None,
        management_set_automatic_purge_id: Optional[str] = None,
        number_of_days_to_keep: Optional[float] = None,
        number_of_sessions_to_keep: Optional[float] = None,
        scheduling: Optional[Mapping[str, str]] = None) -> ManagementSetAutomaticPurge
    func GetManagementSetAutomaticPurge(ctx *Context, name string, id IDInput, state *ManagementSetAutomaticPurgeState, opts ...ResourceOption) (*ManagementSetAutomaticPurge, error)
    public static ManagementSetAutomaticPurge Get(string name, Input<string> id, ManagementSetAutomaticPurgeState? state, CustomResourceOptions? opts = null)
    public static ManagementSetAutomaticPurge get(String name, Output<String> id, ManagementSetAutomaticPurgeState state, CustomResourceOptions options)
    resources:  _:    type: checkpoint:ManagementSetAutomaticPurge    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.
    The following state arguments are supported:
    Enabled bool
    Turn on/off the automatic-purge feature.
    KeepSessionsByCount bool
    Whether or not to keep the latest N sessions. Note: when the automatic purge feature is enabled, this field and/or the "keep-sessions-by-date" field must be set to 'true'.
    KeepSessionsByDays bool
    Whether or not to keep the sessions for D days. Note: when the automatic purge feature is enabled, this field and/or the "keep-sessions-by-count" field must be set to 'true'.
    ManagementSetAutomaticPurgeId string
    NumberOfDaysToKeep double
    When "keep-sessions-by-days = true" this sets the number of days to keep the sessions.
    NumberOfSessionsToKeep double
    When "keep-sessions-by-count = true" this sets the number of newest sessions to preserve, by the sessions's publish date.
    Scheduling Dictionary<string, string>
    When to purge sessions that do not meet the "keep" criteria. Note: when the automatic purge feature is enabled, this field must be set.scheduling blocks are documented below.
    Enabled bool
    Turn on/off the automatic-purge feature.
    KeepSessionsByCount bool
    Whether or not to keep the latest N sessions. Note: when the automatic purge feature is enabled, this field and/or the "keep-sessions-by-date" field must be set to 'true'.
    KeepSessionsByDays bool
    Whether or not to keep the sessions for D days. Note: when the automatic purge feature is enabled, this field and/or the "keep-sessions-by-count" field must be set to 'true'.
    ManagementSetAutomaticPurgeId string
    NumberOfDaysToKeep float64
    When "keep-sessions-by-days = true" this sets the number of days to keep the sessions.
    NumberOfSessionsToKeep float64
    When "keep-sessions-by-count = true" this sets the number of newest sessions to preserve, by the sessions's publish date.
    Scheduling map[string]string
    When to purge sessions that do not meet the "keep" criteria. Note: when the automatic purge feature is enabled, this field must be set.scheduling blocks are documented below.
    enabled Boolean
    Turn on/off the automatic-purge feature.
    keepSessionsByCount Boolean
    Whether or not to keep the latest N sessions. Note: when the automatic purge feature is enabled, this field and/or the "keep-sessions-by-date" field must be set to 'true'.
    keepSessionsByDays Boolean
    Whether or not to keep the sessions for D days. Note: when the automatic purge feature is enabled, this field and/or the "keep-sessions-by-count" field must be set to 'true'.
    managementSetAutomaticPurgeId String
    numberOfDaysToKeep Double
    When "keep-sessions-by-days = true" this sets the number of days to keep the sessions.
    numberOfSessionsToKeep Double
    When "keep-sessions-by-count = true" this sets the number of newest sessions to preserve, by the sessions's publish date.
    scheduling Map<String,String>
    When to purge sessions that do not meet the "keep" criteria. Note: when the automatic purge feature is enabled, this field must be set.scheduling blocks are documented below.
    enabled boolean
    Turn on/off the automatic-purge feature.
    keepSessionsByCount boolean
    Whether or not to keep the latest N sessions. Note: when the automatic purge feature is enabled, this field and/or the "keep-sessions-by-date" field must be set to 'true'.
    keepSessionsByDays boolean
    Whether or not to keep the sessions for D days. Note: when the automatic purge feature is enabled, this field and/or the "keep-sessions-by-count" field must be set to 'true'.
    managementSetAutomaticPurgeId string
    numberOfDaysToKeep number
    When "keep-sessions-by-days = true" this sets the number of days to keep the sessions.
    numberOfSessionsToKeep number
    When "keep-sessions-by-count = true" this sets the number of newest sessions to preserve, by the sessions's publish date.
    scheduling {[key: string]: string}
    When to purge sessions that do not meet the "keep" criteria. Note: when the automatic purge feature is enabled, this field must be set.scheduling blocks are documented below.
    enabled bool
    Turn on/off the automatic-purge feature.
    keep_sessions_by_count bool
    Whether or not to keep the latest N sessions. Note: when the automatic purge feature is enabled, this field and/or the "keep-sessions-by-date" field must be set to 'true'.
    keep_sessions_by_days bool
    Whether or not to keep the sessions for D days. Note: when the automatic purge feature is enabled, this field and/or the "keep-sessions-by-count" field must be set to 'true'.
    management_set_automatic_purge_id str
    number_of_days_to_keep float
    When "keep-sessions-by-days = true" this sets the number of days to keep the sessions.
    number_of_sessions_to_keep float
    When "keep-sessions-by-count = true" this sets the number of newest sessions to preserve, by the sessions's publish date.
    scheduling Mapping[str, str]
    When to purge sessions that do not meet the "keep" criteria. Note: when the automatic purge feature is enabled, this field must be set.scheduling blocks are documented below.
    enabled Boolean
    Turn on/off the automatic-purge feature.
    keepSessionsByCount Boolean
    Whether or not to keep the latest N sessions. Note: when the automatic purge feature is enabled, this field and/or the "keep-sessions-by-date" field must be set to 'true'.
    keepSessionsByDays Boolean
    Whether or not to keep the sessions for D days. Note: when the automatic purge feature is enabled, this field and/or the "keep-sessions-by-count" field must be set to 'true'.
    managementSetAutomaticPurgeId String
    numberOfDaysToKeep Number
    When "keep-sessions-by-days = true" this sets the number of days to keep the sessions.
    numberOfSessionsToKeep Number
    When "keep-sessions-by-count = true" this sets the number of newest sessions to preserve, by the sessions's publish date.
    scheduling Map<String>
    When to purge sessions that do not meet the "keep" criteria. Note: when the automatic purge feature is enabled, this field must be set.scheduling blocks are documented below.

    Package Details

    Repository
    checkpoint checkpointsw/terraform-provider-checkpoint
    License
    Notes
    This Pulumi package is based on the checkpoint Terraform Provider.
    checkpoint logo
    checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw
    checkpointsw/terraform-provider-checkpoint