published on Saturday, Mar 21, 2026 by Pulumi
published on Saturday, Mar 21, 2026 by Pulumi
DataFilteringProfile resource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as scm from "@pulumi/scm";
const scmDataFilteringProfileExample = new scm.DataObject("scm_data_filtering_profile_example", {
name: "tf-data-object-df",
folder: "ngfw-shared",
patternType: {
predefined: {
patterns: [{
fileType: ["text/html"],
name: "ABA-Routing-Number",
}],
},
},
});
const scmDataFilteringProfileExampleDataFilteringProfile = new scm.DataFilteringProfile("scm_data_filtering_profile_example", {
name: "tf-data-filtering",
dataCapture: false,
description: "Terraform Description",
folder: "ngfw-shared",
rules: [{
name: "rule0",
dataObject: scmDataFilteringProfileExample.name,
application: ["any"],
fileType: ["any"],
direction: "both",
alertThreshold: 1,
blockThreshold: 1,
logSeverity: "informational",
}],
});
import pulumi
import pulumi_scm as scm
scm_data_filtering_profile_example = scm.DataObject("scm_data_filtering_profile_example",
name="tf-data-object-df",
folder="ngfw-shared",
pattern_type={
"predefined": {
"patterns": [{
"file_type": ["text/html"],
"name": "ABA-Routing-Number",
}],
},
})
scm_data_filtering_profile_example_data_filtering_profile = scm.DataFilteringProfile("scm_data_filtering_profile_example",
name="tf-data-filtering",
data_capture=False,
description="Terraform Description",
folder="ngfw-shared",
rules=[{
"name": "rule0",
"data_object": scm_data_filtering_profile_example.name,
"application": ["any"],
"file_type": ["any"],
"direction": "both",
"alert_threshold": 1,
"block_threshold": 1,
"log_severity": "informational",
}])
package main
import (
"github.com/pulumi/pulumi-scm/sdk/go/scm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
scmDataFilteringProfileExample, err := scm.NewDataObject(ctx, "scm_data_filtering_profile_example", &scm.DataObjectArgs{
Name: pulumi.String("tf-data-object-df"),
Folder: pulumi.String("ngfw-shared"),
PatternType: &scm.DataObjectPatternTypeArgs{
Predefined: &scm.DataObjectPatternTypePredefinedArgs{
Patterns: scm.DataObjectPatternTypePredefinedPatternArray{
&scm.DataObjectPatternTypePredefinedPatternArgs{
FileType: []string{
"text/html",
},
Name: pulumi.String("ABA-Routing-Number"),
},
},
},
},
})
if err != nil {
return err
}
_, err = scm.NewDataFilteringProfile(ctx, "scm_data_filtering_profile_example", &scm.DataFilteringProfileArgs{
Name: pulumi.String("tf-data-filtering"),
DataCapture: pulumi.Bool(false),
Description: pulumi.String("Terraform Description"),
Folder: pulumi.String("ngfw-shared"),
Rules: scm.DataFilteringProfileRuleArray{
&scm.DataFilteringProfileRuleArgs{
Name: pulumi.String("rule0"),
DataObject: scmDataFilteringProfileExample.Name,
Application: []string{
"any",
},
FileType: []string{
"any",
},
Direction: pulumi.String("both"),
AlertThreshold: pulumi.Int(1),
BlockThreshold: pulumi.Int(1),
LogSeverity: pulumi.String("informational"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;
return await Deployment.RunAsync(() =>
{
var scmDataFilteringProfileExample = new Scm.DataObject("scm_data_filtering_profile_example", new()
{
Name = "tf-data-object-df",
Folder = "ngfw-shared",
PatternType = new Scm.Inputs.DataObjectPatternTypeArgs
{
Predefined = new Scm.Inputs.DataObjectPatternTypePredefinedArgs
{
Patterns = new[]
{
new Scm.Inputs.DataObjectPatternTypePredefinedPatternArgs
{
FileType = new[]
{
"text/html",
},
Name = "ABA-Routing-Number",
},
},
},
},
});
var scmDataFilteringProfileExampleDataFilteringProfile = new Scm.DataFilteringProfile("scm_data_filtering_profile_example", new()
{
Name = "tf-data-filtering",
DataCapture = false,
Description = "Terraform Description",
Folder = "ngfw-shared",
Rules = new[]
{
new Scm.Inputs.DataFilteringProfileRuleArgs
{
Name = "rule0",
DataObject = scmDataFilteringProfileExample.Name,
Application = new[]
{
"any",
},
FileType = new[]
{
"any",
},
Direction = "both",
AlertThreshold = 1,
BlockThreshold = 1,
LogSeverity = "informational",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.DataObject;
import com.pulumi.scm.DataObjectArgs;
import com.pulumi.scm.inputs.DataObjectPatternTypeArgs;
import com.pulumi.scm.inputs.DataObjectPatternTypePredefinedArgs;
import com.pulumi.scm.DataFilteringProfile;
import com.pulumi.scm.DataFilteringProfileArgs;
import com.pulumi.scm.inputs.DataFilteringProfileRuleArgs;
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 scmDataFilteringProfileExample = new DataObject("scmDataFilteringProfileExample", DataObjectArgs.builder()
.name("tf-data-object-df")
.folder("ngfw-shared")
.patternType(DataObjectPatternTypeArgs.builder()
.predefined(DataObjectPatternTypePredefinedArgs.builder()
.patterns(DataObjectPatternTypePredefinedPatternArgs.builder()
.fileType(List.of("text/html"))
.name("ABA-Routing-Number")
.build())
.build())
.build())
.build());
var scmDataFilteringProfileExampleDataFilteringProfile = new DataFilteringProfile("scmDataFilteringProfileExampleDataFilteringProfile", DataFilteringProfileArgs.builder()
.name("tf-data-filtering")
.dataCapture(false)
.description("Terraform Description")
.folder("ngfw-shared")
.rules(DataFilteringProfileRuleArgs.builder()
.name("rule0")
.dataObject(scmDataFilteringProfileExample.name())
.application(List.of("any"))
.fileType(List.of("any"))
.direction("both")
.alertThreshold(1)
.blockThreshold(1)
.logSeverity("informational")
.build())
.build());
}
}
resources:
scmDataFilteringProfileExample:
type: scm:DataObject
name: scm_data_filtering_profile_example
properties:
name: tf-data-object-df
folder: ngfw-shared
patternType:
predefined:
patterns:
- fileType:
- text/html
name: ABA-Routing-Number
scmDataFilteringProfileExampleDataFilteringProfile:
type: scm:DataFilteringProfile
name: scm_data_filtering_profile_example
properties:
name: tf-data-filtering
dataCapture: false
description: Terraform Description
folder: ngfw-shared
rules:
- name: rule0
dataObject: ${scmDataFilteringProfileExample.name}
application:
- any
fileType:
- any
direction: both
alertThreshold: 1
blockThreshold: 1
logSeverity: informational
Create DataFilteringProfile Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DataFilteringProfile(name: string, args?: DataFilteringProfileArgs, opts?: CustomResourceOptions);@overload
def DataFilteringProfile(resource_name: str,
args: Optional[DataFilteringProfileArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def DataFilteringProfile(resource_name: str,
opts: Optional[ResourceOptions] = None,
data_capture: Optional[bool] = None,
description: Optional[str] = None,
device: Optional[str] = None,
disable_override: Optional[str] = None,
folder: Optional[str] = None,
name: Optional[str] = None,
rules: Optional[Sequence[DataFilteringProfileRuleArgs]] = None,
snippet: Optional[str] = None)func NewDataFilteringProfile(ctx *Context, name string, args *DataFilteringProfileArgs, opts ...ResourceOption) (*DataFilteringProfile, error)public DataFilteringProfile(string name, DataFilteringProfileArgs? args = null, CustomResourceOptions? opts = null)
public DataFilteringProfile(String name, DataFilteringProfileArgs args)
public DataFilteringProfile(String name, DataFilteringProfileArgs args, CustomResourceOptions options)
type: scm:DataFilteringProfile
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 DataFilteringProfileArgs
- 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 DataFilteringProfileArgs
- 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 DataFilteringProfileArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DataFilteringProfileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DataFilteringProfileArgs
- 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 dataFilteringProfileResource = new Scm.Index.DataFilteringProfile("dataFilteringProfileResource", new()
{
DataCapture = false,
Description = "string",
Device = "string",
DisableOverride = "string",
Folder = "string",
Name = "string",
Rules = new[]
{
new Scm.Inputs.DataFilteringProfileRuleArgs
{
AlertThreshold = 0,
Applications = new[]
{
"string",
},
BlockThreshold = 0,
DataObject = "string",
Direction = "string",
FileTypes = new[]
{
"string",
},
LogSeverity = "string",
Name = "string",
},
},
Snippet = "string",
});
example, err := scm.NewDataFilteringProfile(ctx, "dataFilteringProfileResource", &scm.DataFilteringProfileArgs{
DataCapture: pulumi.Bool(false),
Description: pulumi.String("string"),
Device: pulumi.String("string"),
DisableOverride: pulumi.String("string"),
Folder: pulumi.String("string"),
Name: pulumi.String("string"),
Rules: scm.DataFilteringProfileRuleArray{
&scm.DataFilteringProfileRuleArgs{
AlertThreshold: pulumi.Int(0),
Applications: pulumi.StringArray{
pulumi.String("string"),
},
BlockThreshold: pulumi.Int(0),
DataObject: pulumi.String("string"),
Direction: pulumi.String("string"),
FileTypes: pulumi.StringArray{
pulumi.String("string"),
},
LogSeverity: pulumi.String("string"),
Name: pulumi.String("string"),
},
},
Snippet: pulumi.String("string"),
})
var dataFilteringProfileResource = new DataFilteringProfile("dataFilteringProfileResource", DataFilteringProfileArgs.builder()
.dataCapture(false)
.description("string")
.device("string")
.disableOverride("string")
.folder("string")
.name("string")
.rules(DataFilteringProfileRuleArgs.builder()
.alertThreshold(0)
.applications("string")
.blockThreshold(0)
.dataObject("string")
.direction("string")
.fileTypes("string")
.logSeverity("string")
.name("string")
.build())
.snippet("string")
.build());
data_filtering_profile_resource = scm.DataFilteringProfile("dataFilteringProfileResource",
data_capture=False,
description="string",
device="string",
disable_override="string",
folder="string",
name="string",
rules=[{
"alert_threshold": 0,
"applications": ["string"],
"block_threshold": 0,
"data_object": "string",
"direction": "string",
"file_types": ["string"],
"log_severity": "string",
"name": "string",
}],
snippet="string")
const dataFilteringProfileResource = new scm.DataFilteringProfile("dataFilteringProfileResource", {
dataCapture: false,
description: "string",
device: "string",
disableOverride: "string",
folder: "string",
name: "string",
rules: [{
alertThreshold: 0,
applications: ["string"],
blockThreshold: 0,
dataObject: "string",
direction: "string",
fileTypes: ["string"],
logSeverity: "string",
name: "string",
}],
snippet: "string",
});
type: scm:DataFilteringProfile
properties:
dataCapture: false
description: string
device: string
disableOverride: string
folder: string
name: string
rules:
- alertThreshold: 0
applications:
- string
blockThreshold: 0
dataObject: string
direction: string
fileTypes:
- string
logSeverity: string
name: string
snippet: string
DataFilteringProfile 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 DataFilteringProfile resource accepts the following input properties:
- Data
Capture bool - Data capture
- Description string
- The description of the data filtering profile
- Device string
- The device in which the resource is defined
- Disable
Override string - Disable override
- Folder string
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- Name string
- The name of the data filtering profile
- Rules
List<Data
Filtering Profile Rule> - Rules
- Snippet string
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.
- Data
Capture bool - Data capture
- Description string
- The description of the data filtering profile
- Device string
- The device in which the resource is defined
- Disable
Override string - Disable override
- Folder string
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- Name string
- The name of the data filtering profile
- Rules
[]Data
Filtering Profile Rule Args - Rules
- Snippet string
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.
- data
Capture Boolean - Data capture
- description String
- The description of the data filtering profile
- device String
- The device in which the resource is defined
- disable
Override String - Disable override
- folder String
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- name String
- The name of the data filtering profile
- rules
List<Data
Filtering Profile Rule> - Rules
- snippet String
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.
- data
Capture boolean - Data capture
- description string
- The description of the data filtering profile
- device string
- The device in which the resource is defined
- disable
Override string - Disable override
- folder string
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- name string
- The name of the data filtering profile
- rules
Data
Filtering Profile Rule[] - Rules
- snippet string
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.
- data_
capture bool - Data capture
- description str
- The description of the data filtering profile
- device str
- The device in which the resource is defined
- disable_
override str - Disable override
- folder str
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- name str
- The name of the data filtering profile
- rules
Sequence[Data
Filtering Profile Rule Args] - Rules
- snippet str
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.
- data
Capture Boolean - Data capture
- description String
- The description of the data filtering profile
- device String
- The device in which the resource is defined
- disable
Override String - Disable override
- folder String
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- name String
- The name of the data filtering profile
- rules List<Property Map>
- Rules
- snippet String
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.
Outputs
All input properties are implicitly available as output properties. Additionally, the DataFilteringProfile resource produces the following output properties:
Look up Existing DataFilteringProfile Resource
Get an existing DataFilteringProfile 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?: DataFilteringProfileState, opts?: CustomResourceOptions): DataFilteringProfile@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
data_capture: Optional[bool] = None,
description: Optional[str] = None,
device: Optional[str] = None,
disable_override: Optional[str] = None,
folder: Optional[str] = None,
name: Optional[str] = None,
rules: Optional[Sequence[DataFilteringProfileRuleArgs]] = None,
snippet: Optional[str] = None,
tfid: Optional[str] = None) -> DataFilteringProfilefunc GetDataFilteringProfile(ctx *Context, name string, id IDInput, state *DataFilteringProfileState, opts ...ResourceOption) (*DataFilteringProfile, error)public static DataFilteringProfile Get(string name, Input<string> id, DataFilteringProfileState? state, CustomResourceOptions? opts = null)public static DataFilteringProfile get(String name, Output<String> id, DataFilteringProfileState state, CustomResourceOptions options)resources: _: type: scm:DataFilteringProfile 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.
- Data
Capture bool - Data capture
- Description string
- The description of the data filtering profile
- Device string
- The device in which the resource is defined
- Disable
Override string - Disable override
- Folder string
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- Name string
- The name of the data filtering profile
- Rules
List<Data
Filtering Profile Rule> - Rules
- Snippet string
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- Tfid string
- The Terraform ID.
- Data
Capture bool - Data capture
- Description string
- The description of the data filtering profile
- Device string
- The device in which the resource is defined
- Disable
Override string - Disable override
- Folder string
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- Name string
- The name of the data filtering profile
- Rules
[]Data
Filtering Profile Rule Args - Rules
- Snippet string
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- Tfid string
- The Terraform ID.
- data
Capture Boolean - Data capture
- description String
- The description of the data filtering profile
- device String
- The device in which the resource is defined
- disable
Override String - Disable override
- folder String
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- name String
- The name of the data filtering profile
- rules
List<Data
Filtering Profile Rule> - Rules
- snippet String
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- tfid String
- The Terraform ID.
- data
Capture boolean - Data capture
- description string
- The description of the data filtering profile
- device string
- The device in which the resource is defined
- disable
Override string - Disable override
- folder string
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- name string
- The name of the data filtering profile
- rules
Data
Filtering Profile Rule[] - Rules
- snippet string
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- tfid string
- The Terraform ID.
- data_
capture bool - Data capture
- description str
- The description of the data filtering profile
- device str
- The device in which the resource is defined
- disable_
override str - Disable override
- folder str
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- name str
- The name of the data filtering profile
- rules
Sequence[Data
Filtering Profile Rule Args] - Rules
- snippet str
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- tfid str
- The Terraform ID.
- data
Capture Boolean - Data capture
- description String
- The description of the data filtering profile
- device String
- The device in which the resource is defined
- disable
Override String - Disable override
- folder String
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- name String
- The name of the data filtering profile
- rules List<Property Map>
- Rules
- snippet String
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- tfid String
- The Terraform ID.
Supporting Types
DataFilteringProfileRule, DataFilteringProfileRuleArgs
- Alert
Threshold int - Alert threshold
- Applications List<string>
- Application
- Block
Threshold int - Block threshold
- Data
Object string - Data object
- Direction string
- Direction
- File
Types List<string> - File type
- Log
Severity string - Log severity
- Name string
- Name
- Alert
Threshold int - Alert threshold
- Applications []string
- Application
- Block
Threshold int - Block threshold
- Data
Object string - Data object
- Direction string
- Direction
- File
Types []string - File type
- Log
Severity string - Log severity
- Name string
- Name
- alert
Threshold Integer - Alert threshold
- applications List<String>
- Application
- block
Threshold Integer - Block threshold
- data
Object String - Data object
- direction String
- Direction
- file
Types List<String> - File type
- log
Severity String - Log severity
- name String
- Name
- alert
Threshold number - Alert threshold
- applications string[]
- Application
- block
Threshold number - Block threshold
- data
Object string - Data object
- direction string
- Direction
- file
Types string[] - File type
- log
Severity string - Log severity
- name string
- Name
- alert_
threshold int - Alert threshold
- applications Sequence[str]
- Application
- block_
threshold int - Block threshold
- data_
object str - Data object
- direction str
- Direction
- file_
types Sequence[str] - File type
- log_
severity str - Log severity
- name str
- Name
- alert
Threshold Number - Alert threshold
- applications List<String>
- Application
- block
Threshold Number - Block threshold
- data
Object String - Data object
- direction String
- Direction
- file
Types List<String> - File type
- log
Severity String - Log severity
- name String
- Name
Import
The following command can be used to import a resource not managed by Terraform:
$ pulumi import scm:index/dataFilteringProfile:DataFilteringProfile example folder:::id
or
$ pulumi import scm:index/dataFilteringProfile:DataFilteringProfile example :snippet::id
or
$ pulumi import scm:index/dataFilteringProfile:DataFilteringProfile example ::device:id
Note: Please provide just one of folder, snippet, or device for the import command.
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- scm pulumi/pulumi-scm
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
scmTerraform Provider.
published on Saturday, Mar 21, 2026 by Pulumi
