1. Packages
  2. Checkpoint Provider
  3. API Docs
  4. ManagementExport
checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw

checkpoint.ManagementExport

Explore with Pulumi AI

checkpoint logo
checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw

    Create ManagementExport Resource

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

    Constructor syntax

    new ManagementExport(name: string, args?: ManagementExportArgs, opts?: CustomResourceOptions);
    @overload
    def ManagementExport(resource_name: str,
                         args: Optional[ManagementExportArgs] = None,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def ManagementExport(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         exclude_classes: Optional[Sequence[str]] = None,
                         exclude_topics: Optional[Sequence[str]] = None,
                         export_files_by_class: Optional[bool] = None,
                         include_classes: Optional[Sequence[str]] = None,
                         include_topics: Optional[Sequence[str]] = None,
                         management_export_id: Optional[str] = None,
                         query_limit: Optional[float] = None)
    func NewManagementExport(ctx *Context, name string, args *ManagementExportArgs, opts ...ResourceOption) (*ManagementExport, error)
    public ManagementExport(string name, ManagementExportArgs? args = null, CustomResourceOptions? opts = null)
    public ManagementExport(String name, ManagementExportArgs args)
    public ManagementExport(String name, ManagementExportArgs args, CustomResourceOptions options)
    
    type: checkpoint:ManagementExport
    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 ManagementExportArgs
    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 ManagementExportArgs
    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 ManagementExportArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ManagementExportArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ManagementExportArgs
    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 managementExportResource = new Checkpoint.ManagementExport("managementExportResource", new()
    {
        ExcludeClasses = new[]
        {
            "string",
        },
        ExcludeTopics = new[]
        {
            "string",
        },
        ExportFilesByClass = false,
        IncludeClasses = new[]
        {
            "string",
        },
        IncludeTopics = new[]
        {
            "string",
        },
        ManagementExportId = "string",
        QueryLimit = 0,
    });
    
    example, err := checkpoint.NewManagementExport(ctx, "managementExportResource", &checkpoint.ManagementExportArgs{
    	ExcludeClasses: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ExcludeTopics: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ExportFilesByClass: pulumi.Bool(false),
    	IncludeClasses: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	IncludeTopics: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ManagementExportId: pulumi.String("string"),
    	QueryLimit:         pulumi.Float64(0),
    })
    
    var managementExportResource = new ManagementExport("managementExportResource", ManagementExportArgs.builder()
        .excludeClasses("string")
        .excludeTopics("string")
        .exportFilesByClass(false)
        .includeClasses("string")
        .includeTopics("string")
        .managementExportId("string")
        .queryLimit(0)
        .build());
    
    management_export_resource = checkpoint.ManagementExport("managementExportResource",
        exclude_classes=["string"],
        exclude_topics=["string"],
        export_files_by_class=False,
        include_classes=["string"],
        include_topics=["string"],
        management_export_id="string",
        query_limit=0)
    
    const managementExportResource = new checkpoint.ManagementExport("managementExportResource", {
        excludeClasses: ["string"],
        excludeTopics: ["string"],
        exportFilesByClass: false,
        includeClasses: ["string"],
        includeTopics: ["string"],
        managementExportId: "string",
        queryLimit: 0,
    });
    
    type: checkpoint:ManagementExport
    properties:
        excludeClasses:
            - string
        excludeTopics:
            - string
        exportFilesByClass: false
        includeClasses:
            - string
        includeTopics:
            - string
        managementExportId: string
        queryLimit: 0
    

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

    ExcludeClasses List<string>
    N/Aexclude_classes blocks are documented below.
    ExcludeTopics List<string>
    N/Aexclude_topics blocks are documented below.
    ExportFilesByClass bool
    N/A
    IncludeClasses List<string>
    N/Ainclude_classes blocks are documented below.
    IncludeTopics List<string>
    N/Ainclude_topics blocks are documented below.
    ManagementExportId string
    QueryLimit double
    N/A
    ExcludeClasses []string
    N/Aexclude_classes blocks are documented below.
    ExcludeTopics []string
    N/Aexclude_topics blocks are documented below.
    ExportFilesByClass bool
    N/A
    IncludeClasses []string
    N/Ainclude_classes blocks are documented below.
    IncludeTopics []string
    N/Ainclude_topics blocks are documented below.
    ManagementExportId string
    QueryLimit float64
    N/A
    excludeClasses List<String>
    N/Aexclude_classes blocks are documented below.
    excludeTopics List<String>
    N/Aexclude_topics blocks are documented below.
    exportFilesByClass Boolean
    N/A
    includeClasses List<String>
    N/Ainclude_classes blocks are documented below.
    includeTopics List<String>
    N/Ainclude_topics blocks are documented below.
    managementExportId String
    queryLimit Double
    N/A
    excludeClasses string[]
    N/Aexclude_classes blocks are documented below.
    excludeTopics string[]
    N/Aexclude_topics blocks are documented below.
    exportFilesByClass boolean
    N/A
    includeClasses string[]
    N/Ainclude_classes blocks are documented below.
    includeTopics string[]
    N/Ainclude_topics blocks are documented below.
    managementExportId string
    queryLimit number
    N/A
    exclude_classes Sequence[str]
    N/Aexclude_classes blocks are documented below.
    exclude_topics Sequence[str]
    N/Aexclude_topics blocks are documented below.
    export_files_by_class bool
    N/A
    include_classes Sequence[str]
    N/Ainclude_classes blocks are documented below.
    include_topics Sequence[str]
    N/Ainclude_topics blocks are documented below.
    management_export_id str
    query_limit float
    N/A
    excludeClasses List<String>
    N/Aexclude_classes blocks are documented below.
    excludeTopics List<String>
    N/Aexclude_topics blocks are documented below.
    exportFilesByClass Boolean
    N/A
    includeClasses List<String>
    N/Ainclude_classes blocks are documented below.
    includeTopics List<String>
    N/Ainclude_topics blocks are documented below.
    managementExportId String
    queryLimit Number
    N/A

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ManagementExport resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    TaskId string
    Asynchronous task unique identifier.
    Id string
    The provider-assigned unique ID for this managed resource.
    TaskId string
    Asynchronous task unique identifier.
    id String
    The provider-assigned unique ID for this managed resource.
    taskId String
    Asynchronous task unique identifier.
    id string
    The provider-assigned unique ID for this managed resource.
    taskId string
    Asynchronous task unique identifier.
    id str
    The provider-assigned unique ID for this managed resource.
    task_id str
    Asynchronous task unique identifier.
    id String
    The provider-assigned unique ID for this managed resource.
    taskId String
    Asynchronous task unique identifier.

    Look up Existing ManagementExport Resource

    Get an existing ManagementExport 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?: ManagementExportState, opts?: CustomResourceOptions): ManagementExport
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            exclude_classes: Optional[Sequence[str]] = None,
            exclude_topics: Optional[Sequence[str]] = None,
            export_files_by_class: Optional[bool] = None,
            include_classes: Optional[Sequence[str]] = None,
            include_topics: Optional[Sequence[str]] = None,
            management_export_id: Optional[str] = None,
            query_limit: Optional[float] = None,
            task_id: Optional[str] = None) -> ManagementExport
    func GetManagementExport(ctx *Context, name string, id IDInput, state *ManagementExportState, opts ...ResourceOption) (*ManagementExport, error)
    public static ManagementExport Get(string name, Input<string> id, ManagementExportState? state, CustomResourceOptions? opts = null)
    public static ManagementExport get(String name, Output<String> id, ManagementExportState state, CustomResourceOptions options)
    resources:  _:    type: checkpoint:ManagementExport    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:
    ExcludeClasses List<string>
    N/Aexclude_classes blocks are documented below.
    ExcludeTopics List<string>
    N/Aexclude_topics blocks are documented below.
    ExportFilesByClass bool
    N/A
    IncludeClasses List<string>
    N/Ainclude_classes blocks are documented below.
    IncludeTopics List<string>
    N/Ainclude_topics blocks are documented below.
    ManagementExportId string
    QueryLimit double
    N/A
    TaskId string
    Asynchronous task unique identifier.
    ExcludeClasses []string
    N/Aexclude_classes blocks are documented below.
    ExcludeTopics []string
    N/Aexclude_topics blocks are documented below.
    ExportFilesByClass bool
    N/A
    IncludeClasses []string
    N/Ainclude_classes blocks are documented below.
    IncludeTopics []string
    N/Ainclude_topics blocks are documented below.
    ManagementExportId string
    QueryLimit float64
    N/A
    TaskId string
    Asynchronous task unique identifier.
    excludeClasses List<String>
    N/Aexclude_classes blocks are documented below.
    excludeTopics List<String>
    N/Aexclude_topics blocks are documented below.
    exportFilesByClass Boolean
    N/A
    includeClasses List<String>
    N/Ainclude_classes blocks are documented below.
    includeTopics List<String>
    N/Ainclude_topics blocks are documented below.
    managementExportId String
    queryLimit Double
    N/A
    taskId String
    Asynchronous task unique identifier.
    excludeClasses string[]
    N/Aexclude_classes blocks are documented below.
    excludeTopics string[]
    N/Aexclude_topics blocks are documented below.
    exportFilesByClass boolean
    N/A
    includeClasses string[]
    N/Ainclude_classes blocks are documented below.
    includeTopics string[]
    N/Ainclude_topics blocks are documented below.
    managementExportId string
    queryLimit number
    N/A
    taskId string
    Asynchronous task unique identifier.
    exclude_classes Sequence[str]
    N/Aexclude_classes blocks are documented below.
    exclude_topics Sequence[str]
    N/Aexclude_topics blocks are documented below.
    export_files_by_class bool
    N/A
    include_classes Sequence[str]
    N/Ainclude_classes blocks are documented below.
    include_topics Sequence[str]
    N/Ainclude_topics blocks are documented below.
    management_export_id str
    query_limit float
    N/A
    task_id str
    Asynchronous task unique identifier.
    excludeClasses List<String>
    N/Aexclude_classes blocks are documented below.
    excludeTopics List<String>
    N/Aexclude_topics blocks are documented below.
    exportFilesByClass Boolean
    N/A
    includeClasses List<String>
    N/Ainclude_classes blocks are documented below.
    includeTopics List<String>
    N/Ainclude_topics blocks are documented below.
    managementExportId String
    queryLimit Number
    N/A
    taskId String
    Asynchronous task unique identifier.

    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